Compare commits
363 Commits
copilot/fi
...
feat/v2/ca
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
67f726afb7 | ||
|
|
d98d69e28d | ||
|
|
3f671ba6be | ||
|
|
78e593fac4 | ||
|
|
9933b0b12f | ||
|
|
bceeef5190 | ||
|
|
cf7b4dd07b | ||
|
|
fe88cfe106 | ||
|
|
62309ae1bf | ||
|
|
c48f222cdb | ||
|
|
cea0058f87 | ||
|
|
852192dce6 | ||
|
|
e3bf63d7a0 | ||
|
|
9a356cb27d | ||
|
|
53883a27be | ||
|
|
24c9c157f9 | ||
|
|
55727e2adf | ||
|
|
eee49d1580 | ||
|
|
1e4239d189 | ||
|
|
5ccb16a0be | ||
|
|
34c9a6b350 | ||
|
|
ab99366a0a | ||
|
|
dcdd1bf852 | ||
|
|
7419cadd80 | ||
|
|
46f2726a63 | ||
|
|
7bd3e047d2 | ||
|
|
1ea19adfec | ||
|
|
1685590a07 | ||
|
|
db10bdd539 | ||
|
|
d79602325d | ||
|
|
a19419e597 | ||
|
|
a12b6bfeca | ||
|
|
a7686f61c7 | ||
|
|
e694ae68e3 | ||
|
|
02a65daa27 | ||
|
|
0f1a487bb0 | ||
|
|
2df8bb58df | ||
|
|
62976f6fe0 | ||
|
|
1a9fd77599 | ||
|
|
77529b3cd3 | ||
|
|
c8e9a10190 | ||
|
|
0e011ff35f | ||
|
|
40a64a7c92 | ||
|
|
dc9503ef8b | ||
|
|
f2c8484c48 | ||
|
|
7fa97f8a2b | ||
|
|
838bb385fd | ||
|
|
583e4e9db7 | ||
|
|
a9c9224835 | ||
|
|
43223fd1f5 | ||
|
|
4bac843b37 | ||
|
|
34723934f4 | ||
|
|
5fdfa5a594 | ||
|
|
096c36caf8 | ||
|
|
139950e193 | ||
|
|
ad939f4b77 | ||
|
|
6abe5ab8c3 | ||
|
|
31eec403f7 | ||
|
|
7fd4837a47 | ||
|
|
90b0c8b4a6 | ||
|
|
556353e910 | ||
|
|
11fb730b4d | ||
|
|
2511113b62 | ||
|
|
a29b2bb3d6 | ||
|
|
d2be450906 | ||
|
|
1156b12ac6 | ||
|
|
9c020f0d56 | ||
|
|
e033eb5b5c | ||
|
|
073d43c7cb | ||
|
|
fa7646e18f | ||
|
|
4410599dfa | ||
|
|
bce8e5cc7f | ||
|
|
9d75b0972e | ||
|
|
038d30831c | ||
|
|
68ee5164f0 | ||
|
|
a1a3b9bd96 | ||
|
|
a3062d6e38 | ||
|
|
4e699c48bc | ||
|
|
75fcf8fbb5 | ||
|
|
35aa9d7355 | ||
|
|
b08aecb22b | ||
|
|
45fc6c2afd | ||
|
|
d6e7ce330e | ||
|
|
43fb232cca | ||
|
|
4f7d8731ea | ||
|
|
2b5ac5ab51 | ||
|
|
060fcd2ce6 | ||
|
|
d610943f0f | ||
|
|
680fcb4b9d | ||
|
|
a6182eaf85 | ||
|
|
649f9420a4 | ||
|
|
d82e004f57 | ||
|
|
aa13ad4fac | ||
|
|
02d79f47b3 | ||
|
|
75c0923636 | ||
|
|
7dd1ecd4a5 | ||
|
|
2552d97ea7 | ||
|
|
803f4b5a64 | ||
|
|
31f8fff6e2 | ||
|
|
a2299fa2ab | ||
|
|
a830d05790 | ||
|
|
8429e678bc | ||
|
|
91215c899d | ||
|
|
1309b194e9 | ||
|
|
1b1f85b35f | ||
|
|
4407c0f675 | ||
|
|
30947c6bc1 | ||
|
|
0b3cefb125 | ||
|
|
2663cb19ce | ||
|
|
ce5d46bfc7 | ||
|
|
c1fa24522d | ||
|
|
2f66f5b511 | ||
|
|
b382b06c57 | ||
|
|
8246f46e7d | ||
|
|
2d8555c326 | ||
|
|
f32fa08c41 | ||
|
|
e2c8edab61 | ||
|
|
5e0a66fa1f | ||
|
|
bc8b0a8d53 | ||
|
|
e43562423e | ||
|
|
120ac122eb | ||
|
|
9013fcba14 | ||
|
|
c32f4badbd | ||
|
|
66f66fe08e | ||
|
|
d5826c2dc7 | ||
|
|
85a628f8dd | ||
|
|
ed453750fe | ||
|
|
57d9a31c0f | ||
|
|
58afbe8a79 | ||
|
|
9a10516b52 | ||
|
|
e268e69597 | ||
|
|
56df52d850 | ||
|
|
846a7f5ecf | ||
|
|
10e78ac60e | ||
|
|
44b2b859da | ||
|
|
bfef0c5580 | ||
|
|
f2c2a27622 | ||
|
|
348e0dfc80 | ||
|
|
77c848035d | ||
|
|
1e8055031a | ||
|
|
8e33ff8d90 | ||
|
|
cd6a38ebeb | ||
|
|
b57ed07d00 | ||
|
|
a619000340 | ||
|
|
f7c8fb8d56 | ||
|
|
dae10cf673 | ||
|
|
a50da9fc80 | ||
|
|
7d5d9964d7 | ||
|
|
78278ce96d | ||
|
|
76483d828e | ||
|
|
059f821584 | ||
|
|
1c38e31e9e | ||
|
|
12e3a22726 | ||
|
|
2b1269af92 | ||
|
|
c4fa975b89 | ||
|
|
816a92c609 | ||
|
|
83e4d4363f | ||
|
|
1b67b851b7 | ||
|
|
811e702568 | ||
|
|
1103449a4f | ||
|
|
56c7a7f066 | ||
|
|
caa59c4c50 | ||
|
|
2546dfbe5d | ||
|
|
5fea202a7d | ||
|
|
7dce1d776b | ||
|
|
346af4d338 | ||
|
|
4ef4297391 | ||
|
|
292f7f7b75 | ||
|
|
e56edbaa4f | ||
|
|
e06142b89a | ||
|
|
fb6b326947 | ||
|
|
f9b7ff7d0e | ||
|
|
14706ec4d7 | ||
|
|
09f2fb6538 | ||
|
|
62aedcaa23 | ||
|
|
62ccb6105d | ||
|
|
5101488d65 | ||
|
|
7c0b03dbdc | ||
|
|
b3dc2d0422 | ||
|
|
1828ef8997 | ||
|
|
b3f88a7fc2 | ||
|
|
2c07ea0dd8 | ||
|
|
6042ee8ca8 | ||
|
|
d164d7c8bf | ||
|
|
23f7b39753 | ||
|
|
fe188ba8fb | ||
|
|
cf008ca22e | ||
|
|
851ff8992f | ||
|
|
91f9088436 | ||
|
|
c971daf23c | ||
|
|
0c7cee2700 | ||
|
|
3e9d9f16d6 | ||
|
|
f3a279d8de | ||
|
|
b9a947d2fd | ||
|
|
57b9ca111a | ||
|
|
709f264ac9 | ||
|
|
736aef22c4 | ||
|
|
d0ed4cc1f2 | ||
|
|
8c6a577cca | ||
|
|
27b6ad75df | ||
|
|
c617a0b51a | ||
|
|
75d7ed075b | ||
|
|
b5b577dc79 | ||
|
|
e754b5a863 | ||
|
|
82dd771110 | ||
|
|
8a4a34a946 | ||
|
|
fb62ae18b7 | ||
|
|
e59990d24e | ||
|
|
b08228bdb5 | ||
|
|
d2b6433609 | ||
|
|
3417acafe2 | ||
|
|
f42afe28d7 | ||
|
|
0da9252eb7 | ||
|
|
de5fa5e09c | ||
|
|
8d64bb0316 | ||
|
|
d7eb88f7e2 | ||
|
|
b41e1d712f | ||
|
|
c258035f6a | ||
|
|
569572bfdc | ||
|
|
b821ac5390 | ||
|
|
534c2ce485 | ||
|
|
bab1a5445c | ||
|
|
742f901052 | ||
|
|
cb12bb5137 | ||
|
|
06b6f2b9d8 | ||
|
|
2c102ed3b4 | ||
|
|
767e22c58d | ||
|
|
dee397f6ac | ||
|
|
a00aba23bd | ||
|
|
de5fb03efb | ||
|
|
a6e58776d2 | ||
|
|
bebe745e69 | ||
|
|
ec8c24a1c2 | ||
|
|
db4fcac768 | ||
|
|
6c71b92d1d | ||
|
|
d470fd8b88 | ||
|
|
99962b740c | ||
|
|
ef4bede062 | ||
|
|
e6e1fb0404 | ||
|
|
e6696def10 | ||
|
|
e5a3363021 | ||
|
|
f6ff436294 | ||
|
|
8a9b633af2 | ||
|
|
0a37146ba8 | ||
|
|
ac3dfcbfbe | ||
|
|
5ac09d5311 | ||
|
|
d4fd8ffdcc | ||
|
|
84274d9d85 | ||
|
|
a72feebead | ||
|
|
e930d3de43 | ||
|
|
ecc9923050 | ||
|
|
e469016775 | ||
|
|
15569387c7 | ||
|
|
4f746842a5 | ||
|
|
aab941d89c | ||
|
|
1b04fd065d | ||
|
|
76b3ba5d7e | ||
|
|
355e5b269d | ||
|
|
d4b0272fe7 | ||
|
|
59bf94b118 | ||
|
|
bd7cd22220 | ||
|
|
f48674b2c7 | ||
|
|
56af6f43c0 | ||
|
|
f83c3e171e | ||
|
|
d397a43806 | ||
|
|
8353f331f1 | ||
|
|
8cc6b08831 | ||
|
|
ffe897d58c | ||
|
|
182ac3bc98 | ||
|
|
c0cca4ae44 | ||
|
|
8981d0a09d | ||
|
|
de44938d9b | ||
|
|
75d5dcf275 | ||
|
|
d8f4825e5e | ||
|
|
c242abd81a | ||
|
|
79c9ed963f | ||
|
|
6079961f44 | ||
|
|
04ef5edea2 | ||
|
|
046ed3edef | ||
|
|
6eb9ab30b0 | ||
|
|
1c27481813 | ||
|
|
a6e19f7757 | ||
|
|
6d89f94335 | ||
|
|
2e07b4ea58 | ||
|
|
bf2f6ddd7f | ||
|
|
c936bddfe7 | ||
|
|
d3028f1dd1 | ||
|
|
0038280fba | ||
|
|
0a94609f78 | ||
|
|
f9f8390540 | ||
|
|
91dd6482ce | ||
|
|
016bbff79f | ||
|
|
32f41391c4 | ||
|
|
78a8ebc777 | ||
|
|
57fd73e51a | ||
|
|
bd448b5108 | ||
|
|
a7d12abd1f | ||
|
|
9e3618bc17 | ||
|
|
8cb270ca86 | ||
|
|
d321cd23ef | ||
|
|
9da3e82c47 | ||
|
|
2931e558b3 | ||
|
|
9a847dc5a3 | ||
|
|
c2a1178dff | ||
|
|
7f114ade4d | ||
|
|
7b633641d1 | ||
|
|
1dacdc3178 | ||
|
|
566dd14fed | ||
|
|
68cd87e069 | ||
|
|
1b57ffeb56 | ||
|
|
5d789ef394 | ||
|
|
820d6a6e96 | ||
|
|
0a67ab4103 | ||
|
|
5cc7390bb6 | ||
|
|
2ce4fabc7d | ||
|
|
7b2570974e | ||
|
|
0ef3852029 | ||
|
|
0dce1c57fc | ||
|
|
190ee76cf1 | ||
|
|
83fea49ed2 | ||
|
|
ccc50dbf2b | ||
|
|
6b503c4080 | ||
|
|
40fe381aa5 | ||
|
|
65c24a2f4b | ||
|
|
b15778b16b | ||
|
|
087e825086 | ||
|
|
3dd2bc1a40 | ||
|
|
9bde833419 | ||
|
|
e15005d1cf | ||
|
|
30e6883333 | ||
|
|
99be38c325 | ||
|
|
df876651b9 | ||
|
|
85bdcdc206 | ||
|
|
2860935e5b | ||
|
|
b219e96544 | ||
|
|
c02f93e6b9 | ||
|
|
72f32e4b8f | ||
|
|
a81f13848c | ||
|
|
81538d5709 | ||
|
|
54449e7130 | ||
|
|
c217a0bf02 | ||
|
|
39257f64b1 | ||
|
|
06dab978f7 | ||
|
|
c3f61533f7 | ||
|
|
8715eb1f41 | ||
|
|
92eb5aed7f | ||
|
|
ff965402cd | ||
|
|
973f26f9dd | ||
|
|
4e3f8a8f76 | ||
|
|
21e40db086 | ||
|
|
92cd012037 | ||
|
|
7cd937888e | ||
|
|
ec491f5f24 | ||
|
|
c0efb46c2b | ||
|
|
aa47fc3ed7 | ||
|
|
c3c9f9b3f2 | ||
|
|
d486b56595 | ||
|
|
4bb5ff8086 | ||
|
|
a748162e67 | ||
|
|
610e7481b3 | ||
|
|
9105e0f5c1 | ||
|
|
a248517520 | ||
|
|
d31f35b16d |
9
.github/CODEOWNERS
vendored
9
.github/CODEOWNERS
vendored
@@ -3,3 +3,12 @@
|
||||
/src/main/services/ConfigManager.ts @0xfullex
|
||||
/packages/shared/IpcChannel.ts @0xfullex
|
||||
/src/main/ipc.ts @0xfullex
|
||||
|
||||
/migrations/ @0xfullex
|
||||
/packages/shared/data/ @0xfullex
|
||||
/src/main/data/ @0xfullex
|
||||
/src/renderer/src/data/ @0xfullex
|
||||
|
||||
/packages/ui/ @MyPrototypeWhat
|
||||
|
||||
/app-upgrade-config.json @kangfenmao
|
||||
|
||||
87
.github/workflows/auto-i18n.yml
vendored
87
.github/workflows/auto-i18n.yml
vendored
@@ -1,4 +1,4 @@
|
||||
name: Auto I18N
|
||||
name: Auto I18N Weekly
|
||||
|
||||
env:
|
||||
TRANSLATION_API_KEY: ${{ secrets.TRANSLATE_API_KEY }}
|
||||
@@ -7,14 +7,15 @@ env:
|
||||
TRANSLATION_BASE_LOCALE: ${{ vars.AUTO_I18N_BASE_LOCALE || 'en-us'}}
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
types: [opened, synchronize, reopened]
|
||||
schedule:
|
||||
# Runs at 00:00 UTC every Sunday.
|
||||
# This corresponds to 08:00 AM UTC+8 (Beijing time) every Sunday.
|
||||
- cron: "0 0 * * 0"
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
auto-i18n:
|
||||
runs-on: ubuntu-latest
|
||||
if: github.event_name == 'workflow_dispatch' || github.event.pull_request.head.repo.full_name == 'CherryHQ/cherry-studio'
|
||||
name: Auto I18N
|
||||
permissions:
|
||||
contents: write
|
||||
@@ -24,45 +25,69 @@ jobs:
|
||||
- name: 🐈⬛ Checkout
|
||||
uses: actions/checkout@v5
|
||||
with:
|
||||
ref: ${{ github.event.pull_request.head.ref }}
|
||||
fetch-depth: 0
|
||||
|
||||
- name: 📦 Setting Node.js
|
||||
uses: actions/setup-node@v6
|
||||
with:
|
||||
node-version: 20
|
||||
package-manager-cache: false
|
||||
node-version: 22
|
||||
|
||||
- name: 📦 Install dependencies in isolated directory
|
||||
- name: 📦 Install corepack
|
||||
run: corepack enable && corepack prepare yarn@4.9.1 --activate
|
||||
|
||||
- name: 📂 Get yarn cache directory path
|
||||
id: yarn-cache-dir-path
|
||||
run: echo "dir=$(yarn config get cacheFolder)" >> $GITHUB_OUTPUT
|
||||
|
||||
- name: 💾 Cache yarn dependencies
|
||||
uses: actions/cache@v4
|
||||
with:
|
||||
path: |
|
||||
${{ steps.yarn-cache-dir-path.outputs.dir }}
|
||||
node_modules
|
||||
key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
|
||||
restore-keys: |
|
||||
${{ runner.os }}-yarn-
|
||||
|
||||
- name: 📦 Install dependencies
|
||||
run: |
|
||||
# 在临时目录安装依赖
|
||||
mkdir -p /tmp/translation-deps
|
||||
cd /tmp/translation-deps
|
||||
echo '{"dependencies": {"@cherrystudio/openai": "^6.5.0", "cli-progress": "^3.12.0", "tsx": "^4.20.3", "@biomejs/biome": "2.2.4"}}' > package.json
|
||||
npm install --no-package-lock
|
||||
|
||||
# 设置 NODE_PATH 让项目能找到这些依赖
|
||||
echo "NODE_PATH=/tmp/translation-deps/node_modules" >> $GITHUB_ENV
|
||||
yarn install
|
||||
|
||||
- name: 🏃♀️ Translate
|
||||
run: npx tsx scripts/sync-i18n.ts && npx tsx scripts/auto-translate-i18n.ts
|
||||
run: yarn sync:i18n && yarn auto:i18n
|
||||
|
||||
- name: 🔍 Format
|
||||
run: cd /tmp/translation-deps && npx biome format --config-path /home/runner/work/cherry-studio/cherry-studio/biome.jsonc --write /home/runner/work/cherry-studio/cherry-studio/src/renderer/src/i18n/
|
||||
run: yarn format
|
||||
|
||||
- name: 🔄 Commit changes
|
||||
- name: 🔍 Check for changes
|
||||
id: git_status
|
||||
run: |
|
||||
git config --local user.email "action@github.com"
|
||||
git config --local user.name "GitHub Action"
|
||||
git add .
|
||||
# Check if there are any uncommitted changes
|
||||
git reset -- package.json yarn.lock # 不提交 package.json 和 yarn.lock 的更改
|
||||
if git diff --cached --quiet; then
|
||||
echo "No changes to commit"
|
||||
else
|
||||
git commit -m "fix(i18n): Auto update translations for PR #${{ github.event.pull_request.number }}"
|
||||
fi
|
||||
git diff --exit-code --quiet || echo "::set-output name=has_changes::true"
|
||||
git status --porcelain
|
||||
|
||||
- name: 🚀 Push changes
|
||||
uses: ad-m/github-push-action@master
|
||||
- name: 📅 Set current date for PR title
|
||||
id: set_date
|
||||
run: echo "CURRENT_DATE=$(date +'%b %d, %Y')" >> $GITHUB_ENV # e.g., "Jun 06, 2024"
|
||||
|
||||
- name: 🚀 Create Pull Request if changes exist
|
||||
if: steps.git_status.outputs.has_changes == 'true'
|
||||
uses: peter-evans/create-pull-request@v6
|
||||
with:
|
||||
github_token: ${{ secrets.GITHUB_TOKEN }}
|
||||
branch: ${{ github.event.pull_request.head.ref }}
|
||||
token: ${{ secrets.GITHUB_TOKEN }} # Use the built-in GITHUB_TOKEN for bot actions
|
||||
commit-message: "feat(bot): Weekly automated script run"
|
||||
title: "🤖 Weekly Automated Update: ${{ env.CURRENT_DATE }}"
|
||||
body: |
|
||||
This PR includes changes generated by the weekly auto i18n.
|
||||
Review the changes before merging.
|
||||
|
||||
---
|
||||
_Generated by the automated weekly workflow_
|
||||
branch: "auto-i18n-weekly-${{ github.run_id }}" # Unique branch name
|
||||
base: "main" # Or 'develop', set your base branch
|
||||
delete-branch: true # Delete the branch after merging or closing the PR
|
||||
|
||||
- name: 📢 Notify if no changes
|
||||
if: steps.git_status.outputs.has_changes != 'true'
|
||||
run: echo "Bot script ran, but no changes were detected. No PR created."
|
||||
|
||||
6
.github/workflows/github-issue-tracker.yml
vendored
6
.github/workflows/github-issue-tracker.yml
vendored
@@ -5,7 +5,7 @@ on:
|
||||
types: [opened]
|
||||
schedule:
|
||||
# Run every day at 8:30 Beijing Time (00:30 UTC)
|
||||
- cron: '30 0 * * *'
|
||||
- cron: "30 0 * * *"
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
@@ -56,7 +56,7 @@ jobs:
|
||||
if: steps.check_time.outputs.should_delay == 'false'
|
||||
uses: actions/setup-node@v6
|
||||
with:
|
||||
node-version: '20'
|
||||
node-version: 22
|
||||
|
||||
- name: Process issue with Claude
|
||||
if: steps.check_time.outputs.should_delay == 'false'
|
||||
@@ -123,7 +123,7 @@ jobs:
|
||||
- name: Setup Node.js
|
||||
uses: actions/setup-node@v6
|
||||
with:
|
||||
node-version: '20'
|
||||
node-version: 22
|
||||
|
||||
- name: Process pending issues with Claude
|
||||
uses: anthropics/claude-code-action@main
|
||||
|
||||
6
.github/workflows/nightly-build.yml
vendored
6
.github/workflows/nightly-build.yml
vendored
@@ -3,7 +3,7 @@ name: Nightly Build
|
||||
on:
|
||||
workflow_dispatch:
|
||||
schedule:
|
||||
- cron: '0 17 * * *' # 1:00 BJ Time
|
||||
- cron: "0 17 * * *" # 1:00 BJ Time
|
||||
|
||||
permissions:
|
||||
contents: write
|
||||
@@ -58,7 +58,7 @@ jobs:
|
||||
- name: Install Node.js
|
||||
uses: actions/setup-node@v6
|
||||
with:
|
||||
node-version: 20
|
||||
node-version: 22
|
||||
|
||||
- name: macos-latest dependencies fix
|
||||
if: matrix.os == 'macos-latest'
|
||||
@@ -66,7 +66,7 @@ jobs:
|
||||
brew install python-setuptools
|
||||
|
||||
- name: Install corepack
|
||||
run: corepack enable && corepack prepare yarn@4.6.0 --activate
|
||||
run: corepack enable && corepack prepare yarn@4.9.1 --activate
|
||||
|
||||
- name: Get yarn cache directory path
|
||||
id: yarn-cache-dir-path
|
||||
|
||||
6
.github/workflows/pr-ci.yml
vendored
6
.github/workflows/pr-ci.yml
vendored
@@ -17,7 +17,7 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
env:
|
||||
PRCI: true
|
||||
if: github.event.pull_request.draft == false
|
||||
if: github.event.pull_request.draft == false || github.head_ref == 'v2'
|
||||
|
||||
steps:
|
||||
- name: Check out Git repository
|
||||
@@ -26,10 +26,10 @@ jobs:
|
||||
- name: Install Node.js
|
||||
uses: actions/setup-node@v6
|
||||
with:
|
||||
node-version: 20
|
||||
node-version: 22
|
||||
|
||||
- name: Install corepack
|
||||
run: corepack enable && corepack prepare yarn@4.6.0 --activate
|
||||
run: corepack enable && corepack prepare yarn@4.9.1 --activate
|
||||
|
||||
- name: Get yarn cache directory path
|
||||
id: yarn-cache-dir-path
|
||||
|
||||
10
.github/workflows/release.yml
vendored
10
.github/workflows/release.yml
vendored
@@ -4,9 +4,9 @@ on:
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
tag:
|
||||
description: 'Release tag (e.g. v1.0.0)'
|
||||
description: "Release tag (e.g. v1.0.0)"
|
||||
required: true
|
||||
default: 'v1.0.0'
|
||||
default: "v1.0.0"
|
||||
push:
|
||||
tags:
|
||||
- v*.*.*
|
||||
@@ -49,7 +49,7 @@ jobs:
|
||||
- name: Install Node.js
|
||||
uses: actions/setup-node@v6
|
||||
with:
|
||||
node-version: 20
|
||||
node-version: 22
|
||||
|
||||
- name: macos-latest dependencies fix
|
||||
if: matrix.os == 'macos-latest'
|
||||
@@ -57,7 +57,7 @@ jobs:
|
||||
brew install python-setuptools
|
||||
|
||||
- name: Install corepack
|
||||
run: corepack enable && corepack prepare yarn@4.6.0 --activate
|
||||
run: corepack enable && corepack prepare yarn@4.9.1 --activate
|
||||
|
||||
- name: Get yarn cache directory path
|
||||
id: yarn-cache-dir-path
|
||||
@@ -127,5 +127,5 @@ jobs:
|
||||
allowUpdates: true
|
||||
makeLatest: false
|
||||
tag: ${{ steps.get-tag.outputs.tag }}
|
||||
artifacts: 'dist/*.exe,dist/*.zip,dist/*.dmg,dist/*.AppImage,dist/*.snap,dist/*.deb,dist/*.rpm,dist/*.tar.gz,dist/latest*.yml,dist/rc*.yml,dist/beta*.yml,dist/*.blockmap'
|
||||
artifacts: "dist/*.exe,dist/*.zip,dist/*.dmg,dist/*.AppImage,dist/*.snap,dist/*.deb,dist/*.rpm,dist/*.tar.gz,dist/latest*.yml,dist/rc*.yml,dist/beta*.yml,dist/*.blockmap"
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
212
.github/workflows/update-app-upgrade-config.yml
vendored
Normal file
212
.github/workflows/update-app-upgrade-config.yml
vendored
Normal file
@@ -0,0 +1,212 @@
|
||||
name: Update App Upgrade Config
|
||||
|
||||
on:
|
||||
release:
|
||||
types:
|
||||
- released
|
||||
- prereleased
|
||||
workflow_dispatch:
|
||||
inputs:
|
||||
tag:
|
||||
description: "Release tag (e.g., v1.2.3)"
|
||||
required: true
|
||||
type: string
|
||||
is_prerelease:
|
||||
description: "Mark the tag as a prerelease when running manually"
|
||||
required: false
|
||||
default: false
|
||||
type: boolean
|
||||
|
||||
permissions:
|
||||
contents: write
|
||||
pull-requests: write
|
||||
|
||||
jobs:
|
||||
propose-update:
|
||||
runs-on: ubuntu-latest
|
||||
if: github.event_name == 'workflow_dispatch' || (github.event_name == 'release' && github.event.release.draft == false)
|
||||
|
||||
steps:
|
||||
- name: Check if should proceed
|
||||
id: check
|
||||
run: |
|
||||
EVENT="${{ github.event_name }}"
|
||||
|
||||
if [ "$EVENT" = "workflow_dispatch" ]; then
|
||||
TAG="${{ github.event.inputs.tag }}"
|
||||
else
|
||||
TAG="${{ github.event.release.tag_name }}"
|
||||
fi
|
||||
|
||||
latest_tag=$(
|
||||
curl -L \
|
||||
-H "Accept: application/vnd.github+json" \
|
||||
-H "Authorization: Bearer ${{ github.token }}" \
|
||||
-H "X-GitHub-Api-Version: 2022-11-28" \
|
||||
https://api.github.com/repos/${{ github.repository }}/releases/latest \
|
||||
| jq -r '.tag_name'
|
||||
)
|
||||
|
||||
if [ "$EVENT" = "workflow_dispatch" ]; then
|
||||
MANUAL_IS_PRERELEASE="${{ github.event.inputs.is_prerelease }}"
|
||||
if [ -z "$MANUAL_IS_PRERELEASE" ]; then
|
||||
MANUAL_IS_PRERELEASE="false"
|
||||
fi
|
||||
if [ "$MANUAL_IS_PRERELEASE" = "true" ]; then
|
||||
if ! echo "$TAG" | grep -E '(-beta([.-][0-9]+)?|-rc([.-][0-9]+)?)' >/dev/null; then
|
||||
echo "Manual prerelease flag set but tag $TAG lacks beta/rc suffix. Skipping." >&2
|
||||
echo "should_run=false" >> "$GITHUB_OUTPUT"
|
||||
echo "is_prerelease=false" >> "$GITHUB_OUTPUT"
|
||||
echo "latest_tag=$latest_tag" >> "$GITHUB_OUTPUT"
|
||||
exit 0
|
||||
fi
|
||||
fi
|
||||
echo "should_run=true" >> "$GITHUB_OUTPUT"
|
||||
echo "is_prerelease=$MANUAL_IS_PRERELEASE" >> "$GITHUB_OUTPUT"
|
||||
echo "latest_tag=$latest_tag" >> "$GITHUB_OUTPUT"
|
||||
exit 0
|
||||
fi
|
||||
|
||||
IS_PRERELEASE="${{ github.event.release.prerelease }}"
|
||||
|
||||
if [ "$IS_PRERELEASE" = "true" ]; then
|
||||
if ! echo "$TAG" | grep -E '(-beta([.-][0-9]+)?|-rc([.-][0-9]+)?)' >/dev/null; then
|
||||
echo "Release marked as prerelease but tag $TAG lacks beta/rc suffix. Skipping." >&2
|
||||
echo "should_run=false" >> "$GITHUB_OUTPUT"
|
||||
echo "is_prerelease=false" >> "$GITHUB_OUTPUT"
|
||||
echo "latest_tag=$latest_tag" >> "$GITHUB_OUTPUT"
|
||||
exit 0
|
||||
fi
|
||||
echo "should_run=true" >> "$GITHUB_OUTPUT"
|
||||
echo "is_prerelease=true" >> "$GITHUB_OUTPUT"
|
||||
echo "latest_tag=$latest_tag" >> "$GITHUB_OUTPUT"
|
||||
echo "Release is prerelease, proceeding"
|
||||
exit 0
|
||||
fi
|
||||
|
||||
if [[ "${latest_tag}" == "$TAG" ]]; then
|
||||
echo "should_run=true" >> "$GITHUB_OUTPUT"
|
||||
echo "is_prerelease=false" >> "$GITHUB_OUTPUT"
|
||||
echo "latest_tag=$latest_tag" >> "$GITHUB_OUTPUT"
|
||||
echo "Release is latest, proceeding"
|
||||
else
|
||||
echo "should_run=false" >> "$GITHUB_OUTPUT"
|
||||
echo "is_prerelease=false" >> "$GITHUB_OUTPUT"
|
||||
echo "latest_tag=$latest_tag" >> "$GITHUB_OUTPUT"
|
||||
echo "Release is neither prerelease nor latest, skipping"
|
||||
fi
|
||||
|
||||
- name: Prepare metadata
|
||||
id: meta
|
||||
if: steps.check.outputs.should_run == 'true'
|
||||
run: |
|
||||
EVENT="${{ github.event_name }}"
|
||||
LATEST_TAG="${{ steps.check.outputs.latest_tag }}"
|
||||
if [ "$EVENT" = "release" ]; then
|
||||
TAG="${{ github.event.release.tag_name }}"
|
||||
PRE="${{ github.event.release.prerelease }}"
|
||||
|
||||
if [ -n "$LATEST_TAG" ] && [ "$LATEST_TAG" = "$TAG" ]; then
|
||||
LATEST="true"
|
||||
else
|
||||
LATEST="false"
|
||||
fi
|
||||
TRIGGER="release"
|
||||
else
|
||||
TAG="${{ github.event.inputs.tag }}"
|
||||
PRE="${{ github.event.inputs.is_prerelease }}"
|
||||
if [ -z "$PRE" ]; then
|
||||
PRE="false"
|
||||
fi
|
||||
if [ -n "$LATEST_TAG" ] && [ "$LATEST_TAG" = "$TAG" ] && [ "$PRE" != "true" ]; then
|
||||
LATEST="true"
|
||||
else
|
||||
LATEST="false"
|
||||
fi
|
||||
TRIGGER="manual"
|
||||
fi
|
||||
|
||||
SAFE_TAG=$(echo "$TAG" | sed 's/[^A-Za-z0-9._-]/-/g')
|
||||
echo "tag=$TAG" >> "$GITHUB_OUTPUT"
|
||||
echo "safe_tag=$SAFE_TAG" >> "$GITHUB_OUTPUT"
|
||||
echo "prerelease=$PRE" >> "$GITHUB_OUTPUT"
|
||||
echo "latest=$LATEST" >> "$GITHUB_OUTPUT"
|
||||
echo "trigger=$TRIGGER" >> "$GITHUB_OUTPUT"
|
||||
|
||||
- name: Checkout default branch
|
||||
if: steps.check.outputs.should_run == 'true'
|
||||
uses: actions/checkout@v5
|
||||
with:
|
||||
ref: ${{ github.event.repository.default_branch }}
|
||||
path: main
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Checkout x-files/app-upgrade-config branch
|
||||
if: steps.check.outputs.should_run == 'true'
|
||||
uses: actions/checkout@v5
|
||||
with:
|
||||
ref: x-files/app-upgrade-config
|
||||
path: cs
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Setup Node.js
|
||||
if: steps.check.outputs.should_run == 'true'
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: 22
|
||||
|
||||
- name: Enable Corepack
|
||||
if: steps.check.outputs.should_run == 'true'
|
||||
run: corepack enable && corepack prepare yarn@4.9.1 --activate
|
||||
|
||||
- name: Install dependencies
|
||||
if: steps.check.outputs.should_run == 'true'
|
||||
working-directory: main
|
||||
run: yarn install --immutable
|
||||
|
||||
- name: Update upgrade config
|
||||
if: steps.check.outputs.should_run == 'true'
|
||||
working-directory: main
|
||||
env:
|
||||
RELEASE_TAG: ${{ steps.meta.outputs.tag }}
|
||||
IS_PRERELEASE: ${{ steps.check.outputs.is_prerelease }}
|
||||
run: |
|
||||
yarn tsx scripts/update-app-upgrade-config.ts \
|
||||
--tag "$RELEASE_TAG" \
|
||||
--config ../cs/app-upgrade-config.json \
|
||||
--is-prerelease "$IS_PRERELEASE"
|
||||
|
||||
- name: Detect changes
|
||||
if: steps.check.outputs.should_run == 'true'
|
||||
id: diff
|
||||
working-directory: cs
|
||||
run: |
|
||||
if git diff --quiet -- app-upgrade-config.json; then
|
||||
echo "changed=false" >> "$GITHUB_OUTPUT"
|
||||
else
|
||||
echo "changed=true" >> "$GITHUB_OUTPUT"
|
||||
fi
|
||||
|
||||
- name: Create pull request
|
||||
if: steps.check.outputs.should_run == 'true' && steps.diff.outputs.changed == 'true'
|
||||
uses: peter-evans/create-pull-request@v7
|
||||
with:
|
||||
path: cs
|
||||
base: x-files/app-upgrade-config
|
||||
branch: chore/update-app-upgrade-config/${{ steps.meta.outputs.safe_tag }}
|
||||
commit-message: "🤖 chore: sync app-upgrade-config for ${{ steps.meta.outputs.tag }}"
|
||||
title: "chore: update app-upgrade-config for ${{ steps.meta.outputs.tag }}"
|
||||
body: |
|
||||
Automated update triggered by `${{ steps.meta.outputs.trigger }}`.
|
||||
|
||||
- Source tag: `${{ steps.meta.outputs.tag }}`
|
||||
- Pre-release: `${{ steps.meta.outputs.prerelease }}`
|
||||
- Latest: `${{ steps.meta.outputs.latest }}`
|
||||
- Workflow run: https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}
|
||||
labels: |
|
||||
automation
|
||||
app-upgrade
|
||||
|
||||
- name: No changes detected
|
||||
if: steps.check.outputs.should_run == 'true' && steps.diff.outputs.changed != 'true'
|
||||
run: echo "No updates required for x-files/app-upgrade-config/app-upgrade-config.json"
|
||||
@@ -22,12 +22,11 @@
|
||||
"eslint.config.mjs"
|
||||
],
|
||||
"overrides": [
|
||||
// set different env
|
||||
{
|
||||
"env": {
|
||||
"node": true
|
||||
},
|
||||
"files": ["src/main/**", "resources/scripts/**", "scripts/**", "playwright.config.ts", "electron.vite.config.ts"]
|
||||
"files": ["src/main/**", "resources/scripts/**", "scripts/**", "playwright.config.ts", "electron.vite.config.ts", "packages/ui/scripts/**"]
|
||||
},
|
||||
{
|
||||
"env": {
|
||||
@@ -37,7 +36,7 @@
|
||||
"src/renderer/**/*.{ts,tsx}",
|
||||
"packages/aiCore/**",
|
||||
"packages/extension-table-plus/**",
|
||||
"resources/js/**"
|
||||
"packages/ui/**"
|
||||
]
|
||||
},
|
||||
{
|
||||
@@ -53,76 +52,24 @@
|
||||
"node": true
|
||||
},
|
||||
"files": ["src/preload/**"]
|
||||
},
|
||||
{
|
||||
"files": ["packages/ai-sdk-provider/**"],
|
||||
"globals": {
|
||||
"fetch": "readonly"
|
||||
}
|
||||
}
|
||||
],
|
||||
// We don't use the React plugin here because its behavior differs slightly from that of ESLint's React plugin.
|
||||
"plugins": ["unicorn", "typescript", "oxc", "import"],
|
||||
"rules": {
|
||||
"constructor-super": "error",
|
||||
"for-direction": "error",
|
||||
"getter-return": "error",
|
||||
"no-array-constructor": "off",
|
||||
// "import/no-cycle": "error", // tons of error, bro
|
||||
"no-async-promise-executor": "error",
|
||||
"no-caller": "warn",
|
||||
"no-case-declarations": "error",
|
||||
"no-class-assign": "error",
|
||||
"no-compare-neg-zero": "error",
|
||||
"no-cond-assign": "error",
|
||||
"no-const-assign": "error",
|
||||
"no-constant-binary-expression": "error",
|
||||
"no-constant-condition": "error",
|
||||
"no-control-regex": "error",
|
||||
"no-debugger": "error",
|
||||
"no-delete-var": "error",
|
||||
"no-dupe-args": "error",
|
||||
"no-dupe-class-members": "error",
|
||||
"no-dupe-else-if": "error",
|
||||
"no-dupe-keys": "error",
|
||||
"no-duplicate-case": "error",
|
||||
"no-empty": "error",
|
||||
"no-empty-character-class": "error",
|
||||
"no-empty-pattern": "error",
|
||||
"no-empty-static-block": "error",
|
||||
"no-eval": "warn",
|
||||
"no-ex-assign": "error",
|
||||
"no-extra-boolean-cast": "error",
|
||||
"no-fallthrough": "warn",
|
||||
"no-func-assign": "error",
|
||||
"no-global-assign": "error",
|
||||
"no-import-assign": "error",
|
||||
"no-invalid-regexp": "error",
|
||||
"no-irregular-whitespace": "error",
|
||||
"no-loss-of-precision": "error",
|
||||
"no-misleading-character-class": "error",
|
||||
"no-new-native-nonconstructor": "error",
|
||||
"no-nonoctal-decimal-escape": "error",
|
||||
"no-obj-calls": "error",
|
||||
"no-octal": "error",
|
||||
"no-prototype-builtins": "error",
|
||||
"no-redeclare": "error",
|
||||
"no-regex-spaces": "error",
|
||||
"no-self-assign": "error",
|
||||
"no-setter-return": "error",
|
||||
"no-shadow-restricted-names": "error",
|
||||
"no-sparse-arrays": "error",
|
||||
"no-this-before-super": "error",
|
||||
"no-unassigned-vars": "warn",
|
||||
"no-undef": "error",
|
||||
"no-unexpected-multiline": "error",
|
||||
"no-unreachable": "error",
|
||||
"no-unsafe-finally": "error",
|
||||
"no-unsafe-negation": "error",
|
||||
"no-unsafe-optional-chaining": "error",
|
||||
"no-unused-expressions": "off", // this rule disallow us to use expression to call function, like `condition && fn()`
|
||||
"no-unused-labels": "error",
|
||||
"no-unused-private-class-members": "error",
|
||||
"no-unused-expressions": "off",
|
||||
"no-unused-vars": ["warn", { "caughtErrors": "none" }],
|
||||
"no-useless-backreference": "error",
|
||||
"no-useless-catch": "error",
|
||||
"no-useless-escape": "error",
|
||||
"no-useless-rename": "warn",
|
||||
"no-with": "error",
|
||||
"oxc/bad-array-method-on-arguments": "warn",
|
||||
"oxc/bad-char-at-comparison": "warn",
|
||||
"oxc/bad-comparison-sequence": "warn",
|
||||
@@ -134,19 +81,17 @@
|
||||
"oxc/erasing-op": "warn",
|
||||
"oxc/missing-throw": "warn",
|
||||
"oxc/number-arg-out-of-range": "warn",
|
||||
"oxc/only-used-in-recursion": "off", // manually off bacause of existing warning. may turn it on in the future
|
||||
"oxc/only-used-in-recursion": "off",
|
||||
"oxc/uninvoked-array-callback": "warn",
|
||||
"require-yield": "error",
|
||||
"typescript/await-thenable": "warn",
|
||||
// "typescript/ban-ts-comment": "error",
|
||||
"typescript/no-array-constructor": "error",
|
||||
"typescript/consistent-type-imports": "error",
|
||||
"typescript/no-array-constructor": "error",
|
||||
"typescript/no-array-delete": "warn",
|
||||
"typescript/no-base-to-string": "warn",
|
||||
"typescript/no-duplicate-enum-values": "error",
|
||||
"typescript/no-duplicate-type-constituents": "warn",
|
||||
"typescript/no-empty-object-type": "off",
|
||||
"typescript/no-explicit-any": "off", // not safe but too many errors
|
||||
"typescript/no-explicit-any": "off",
|
||||
"typescript/no-extra-non-null-assertion": "error",
|
||||
"typescript/no-floating-promises": "warn",
|
||||
"typescript/no-for-in-array": "warn",
|
||||
@@ -155,7 +100,7 @@
|
||||
"typescript/no-misused-new": "error",
|
||||
"typescript/no-misused-spread": "warn",
|
||||
"typescript/no-namespace": "error",
|
||||
"typescript/no-non-null-asserted-optional-chain": "off", // it's off now. but may turn it on.
|
||||
"typescript/no-non-null-asserted-optional-chain": "off",
|
||||
"typescript/no-redundant-type-constituents": "warn",
|
||||
"typescript/no-require-imports": "off",
|
||||
"typescript/no-this-alias": "error",
|
||||
@@ -173,20 +118,18 @@
|
||||
"typescript/triple-slash-reference": "error",
|
||||
"typescript/unbound-method": "warn",
|
||||
"unicorn/no-await-in-promise-methods": "warn",
|
||||
"unicorn/no-empty-file": "off", // manually off bacause of existing warning. may turn it on in the future
|
||||
"unicorn/no-empty-file": "off",
|
||||
"unicorn/no-invalid-fetch-options": "warn",
|
||||
"unicorn/no-invalid-remove-event-listener": "warn",
|
||||
"unicorn/no-new-array": "off", // manually off bacause of existing warning. may turn it on in the future
|
||||
"unicorn/no-new-array": "off",
|
||||
"unicorn/no-single-promise-in-promise-methods": "warn",
|
||||
"unicorn/no-thenable": "off", // manually off bacause of existing warning. may turn it on in the future
|
||||
"unicorn/no-thenable": "off",
|
||||
"unicorn/no-unnecessary-await": "warn",
|
||||
"unicorn/no-useless-fallback-in-spread": "warn",
|
||||
"unicorn/no-useless-length-check": "warn",
|
||||
"unicorn/no-useless-spread": "off", // manually off bacause of existing warning. may turn it on in the future
|
||||
"unicorn/no-useless-spread": "off",
|
||||
"unicorn/prefer-set-size": "warn",
|
||||
"unicorn/prefer-string-starts-ends-with": "warn",
|
||||
"use-isnan": "error",
|
||||
"valid-typeof": "error"
|
||||
"unicorn/prefer-string-starts-ends-with": "warn"
|
||||
},
|
||||
"settings": {
|
||||
"jsdoc": {
|
||||
|
||||
8
.vscode/settings.json
vendored
8
.vscode/settings.json
vendored
@@ -31,7 +31,8 @@
|
||||
},
|
||||
"editor.formatOnSave": true,
|
||||
"files.associations": {
|
||||
"*.css": "tailwindcss"
|
||||
"*.css": "tailwindcss",
|
||||
".oxlintrc.json": "jsonc"
|
||||
},
|
||||
"files.eol": "\n",
|
||||
// "i18n-ally.displayLanguage": "zh-cn", // 界面显示语言
|
||||
@@ -50,6 +51,9 @@
|
||||
},
|
||||
"tailwindCSS.classAttributes": [
|
||||
"className",
|
||||
"classNames",
|
||||
"classNames"
|
||||
],
|
||||
"tailwindCSS.experimental.classRegex": [
|
||||
["cva\\(([^;]*)[\\);]", "[`'\"`]([^'\"`;]*)[`'\"`]"]
|
||||
]
|
||||
}
|
||||
|
||||
@@ -1,26 +0,0 @@
|
||||
diff --git a/dist/index.js b/dist/index.js
|
||||
index 4cc66d83af1cef39f6447dc62e680251e05ddf9f..eb9819cb674c1808845ceb29936196c4bb355172 100644
|
||||
--- a/dist/index.js
|
||||
+++ b/dist/index.js
|
||||
@@ -471,7 +471,7 @@ function convertToGoogleGenerativeAIMessages(prompt, options) {
|
||||
|
||||
// src/get-model-path.ts
|
||||
function getModelPath(modelId) {
|
||||
- return modelId.includes("/") ? modelId : `models/${modelId}`;
|
||||
+ return modelId.includes("models/") ? modelId : `models/${modelId}`;
|
||||
}
|
||||
|
||||
// src/google-generative-ai-options.ts
|
||||
diff --git a/dist/index.mjs b/dist/index.mjs
|
||||
index a032505ec54e132dc386dde001dc51f710f84c83..5efada51b9a8b56e3f01b35e734908ebe3c37043 100644
|
||||
--- a/dist/index.mjs
|
||||
+++ b/dist/index.mjs
|
||||
@@ -477,7 +477,7 @@ function convertToGoogleGenerativeAIMessages(prompt, options) {
|
||||
|
||||
// src/get-model-path.ts
|
||||
function getModelPath(modelId) {
|
||||
- return modelId.includes("/") ? modelId : `models/${modelId}`;
|
||||
+ return modelId.includes("models/") ? modelId : `models/${modelId}`;
|
||||
}
|
||||
|
||||
// src/google-generative-ai-options.ts
|
||||
152
.yarn/patches/@ai-sdk-google-npm-2.0.36-6f3cc06026.patch
vendored
Normal file
152
.yarn/patches/@ai-sdk-google-npm-2.0.36-6f3cc06026.patch
vendored
Normal file
@@ -0,0 +1,152 @@
|
||||
diff --git a/dist/index.js b/dist/index.js
|
||||
index c2ef089c42e13a8ee4a833899a415564130e5d79..75efa7baafb0f019fb44dd50dec1641eee8879e7 100644
|
||||
--- a/dist/index.js
|
||||
+++ b/dist/index.js
|
||||
@@ -471,7 +471,7 @@ function convertToGoogleGenerativeAIMessages(prompt, options) {
|
||||
|
||||
// src/get-model-path.ts
|
||||
function getModelPath(modelId) {
|
||||
- return modelId.includes("/") ? modelId : `models/${modelId}`;
|
||||
+ return modelId.includes("models/") ? modelId : `models/${modelId}`;
|
||||
}
|
||||
|
||||
// src/google-generative-ai-options.ts
|
||||
diff --git a/dist/index.mjs b/dist/index.mjs
|
||||
index d75c0cc13c41192408c1f3f2d29d76a7bffa6268..ada730b8cb97d9b7d4cb32883a1d1ff416404d9b 100644
|
||||
--- a/dist/index.mjs
|
||||
+++ b/dist/index.mjs
|
||||
@@ -477,7 +477,7 @@ function convertToGoogleGenerativeAIMessages(prompt, options) {
|
||||
|
||||
// src/get-model-path.ts
|
||||
function getModelPath(modelId) {
|
||||
- return modelId.includes("/") ? modelId : `models/${modelId}`;
|
||||
+ return modelId.includes("models/") ? modelId : `models/${modelId}`;
|
||||
}
|
||||
|
||||
// src/google-generative-ai-options.ts
|
||||
diff --git a/dist/internal/index.js b/dist/internal/index.js
|
||||
index 277cac8dc734bea2fb4f3e9a225986b402b24f48..bb704cd79e602eb8b0cee1889e42497d59ccdb7a 100644
|
||||
--- a/dist/internal/index.js
|
||||
+++ b/dist/internal/index.js
|
||||
@@ -432,7 +432,15 @@ function prepareTools({
|
||||
var _a;
|
||||
tools = (tools == null ? void 0 : tools.length) ? tools : void 0;
|
||||
const toolWarnings = [];
|
||||
- const isGemini2 = modelId.includes("gemini-2");
|
||||
+ // These changes could be safely removed when @ai-sdk/google v3 released.
|
||||
+ const isLatest = (
|
||||
+ [
|
||||
+ 'gemini-flash-latest',
|
||||
+ 'gemini-flash-lite-latest',
|
||||
+ 'gemini-pro-latest',
|
||||
+ ]
|
||||
+ ).some(id => id === modelId);
|
||||
+ const isGemini2OrNewer = modelId.includes("gemini-2") || modelId.includes("gemini-3") || isLatest;
|
||||
const supportsDynamicRetrieval = modelId.includes("gemini-1.5-flash") && !modelId.includes("-8b");
|
||||
const supportsFileSearch = modelId.includes("gemini-2.5");
|
||||
if (tools == null) {
|
||||
@@ -458,7 +466,7 @@ function prepareTools({
|
||||
providerDefinedTools.forEach((tool) => {
|
||||
switch (tool.id) {
|
||||
case "google.google_search":
|
||||
- if (isGemini2) {
|
||||
+ if (isGemini2OrNewer) {
|
||||
googleTools2.push({ googleSearch: {} });
|
||||
} else if (supportsDynamicRetrieval) {
|
||||
googleTools2.push({
|
||||
@@ -474,7 +482,7 @@ function prepareTools({
|
||||
}
|
||||
break;
|
||||
case "google.url_context":
|
||||
- if (isGemini2) {
|
||||
+ if (isGemini2OrNewer) {
|
||||
googleTools2.push({ urlContext: {} });
|
||||
} else {
|
||||
toolWarnings.push({
|
||||
@@ -485,7 +493,7 @@ function prepareTools({
|
||||
}
|
||||
break;
|
||||
case "google.code_execution":
|
||||
- if (isGemini2) {
|
||||
+ if (isGemini2OrNewer) {
|
||||
googleTools2.push({ codeExecution: {} });
|
||||
} else {
|
||||
toolWarnings.push({
|
||||
@@ -507,7 +515,7 @@ function prepareTools({
|
||||
}
|
||||
break;
|
||||
case "google.vertex_rag_store":
|
||||
- if (isGemini2) {
|
||||
+ if (isGemini2OrNewer) {
|
||||
googleTools2.push({
|
||||
retrieval: {
|
||||
vertex_rag_store: {
|
||||
diff --git a/dist/internal/index.mjs b/dist/internal/index.mjs
|
||||
index 03b7cc591be9b58bcc2e775a96740d9f98862a10..347d2c12e1cee79f0f8bb258f3844fb0522a6485 100644
|
||||
--- a/dist/internal/index.mjs
|
||||
+++ b/dist/internal/index.mjs
|
||||
@@ -424,7 +424,15 @@ function prepareTools({
|
||||
var _a;
|
||||
tools = (tools == null ? void 0 : tools.length) ? tools : void 0;
|
||||
const toolWarnings = [];
|
||||
- const isGemini2 = modelId.includes("gemini-2");
|
||||
+ // These changes could be safely removed when @ai-sdk/google v3 released.
|
||||
+ const isLatest = (
|
||||
+ [
|
||||
+ 'gemini-flash-latest',
|
||||
+ 'gemini-flash-lite-latest',
|
||||
+ 'gemini-pro-latest',
|
||||
+ ]
|
||||
+ ).some(id => id === modelId);
|
||||
+ const isGemini2OrNewer = modelId.includes("gemini-2") || modelId.includes("gemini-3") || isLatest;
|
||||
const supportsDynamicRetrieval = modelId.includes("gemini-1.5-flash") && !modelId.includes("-8b");
|
||||
const supportsFileSearch = modelId.includes("gemini-2.5");
|
||||
if (tools == null) {
|
||||
@@ -450,7 +458,7 @@ function prepareTools({
|
||||
providerDefinedTools.forEach((tool) => {
|
||||
switch (tool.id) {
|
||||
case "google.google_search":
|
||||
- if (isGemini2) {
|
||||
+ if (isGemini2OrNewer) {
|
||||
googleTools2.push({ googleSearch: {} });
|
||||
} else if (supportsDynamicRetrieval) {
|
||||
googleTools2.push({
|
||||
@@ -466,7 +474,7 @@ function prepareTools({
|
||||
}
|
||||
break;
|
||||
case "google.url_context":
|
||||
- if (isGemini2) {
|
||||
+ if (isGemini2OrNewer) {
|
||||
googleTools2.push({ urlContext: {} });
|
||||
} else {
|
||||
toolWarnings.push({
|
||||
@@ -477,7 +485,7 @@ function prepareTools({
|
||||
}
|
||||
break;
|
||||
case "google.code_execution":
|
||||
- if (isGemini2) {
|
||||
+ if (isGemini2OrNewer) {
|
||||
googleTools2.push({ codeExecution: {} });
|
||||
} else {
|
||||
toolWarnings.push({
|
||||
@@ -499,7 +507,7 @@ function prepareTools({
|
||||
}
|
||||
break;
|
||||
case "google.vertex_rag_store":
|
||||
- if (isGemini2) {
|
||||
+ if (isGemini2OrNewer) {
|
||||
googleTools2.push({
|
||||
retrieval: {
|
||||
vertex_rag_store: {
|
||||
@@ -1434,9 +1442,7 @@ var googleTools = {
|
||||
vertexRagStore
|
||||
};
|
||||
export {
|
||||
- GoogleGenerativeAILanguageModel,
|
||||
getGroundingMetadataSchema,
|
||||
- getUrlContextMetadataSchema,
|
||||
- googleTools
|
||||
+ getUrlContextMetadataSchema, GoogleGenerativeAILanguageModel, googleTools
|
||||
};
|
||||
//# sourceMappingURL=index.mjs.map
|
||||
\ No newline at end of file
|
||||
@@ -1,5 +1,5 @@
|
||||
diff --git a/dist/index.js b/dist/index.js
|
||||
index cc6652c4e7f32878a64a2614115bf7eeb3b7c890..76e989017549c89b45d633525efb1f318026d9b2 100644
|
||||
index 992c85ac6656e51c3471af741583533c5a7bf79f..83c05952a07aebb95fc6c62f9ddb8aa96b52ac0d 100644
|
||||
--- a/dist/index.js
|
||||
+++ b/dist/index.js
|
||||
@@ -274,6 +274,7 @@ var openaiChatResponseSchema = (0, import_provider_utils3.lazyValidator)(
|
||||
@@ -18,30 +18,29 @@ index cc6652c4e7f32878a64a2614115bf7eeb3b7c890..76e989017549c89b45d633525efb1f31
|
||||
tool_calls: import_v42.z.array(
|
||||
import_v42.z.object({
|
||||
index: import_v42.z.number(),
|
||||
@@ -785,6 +787,14 @@ var OpenAIChatLanguageModel = class {
|
||||
@@ -785,6 +787,13 @@ var OpenAIChatLanguageModel = class {
|
||||
if (text != null && text.length > 0) {
|
||||
content.push({ type: "text", text });
|
||||
}
|
||||
+ const reasoning =
|
||||
+ choice.message.reasoning_content;
|
||||
+ const reasoning = choice.message.reasoning_content;
|
||||
+ if (reasoning != null && reasoning.length > 0) {
|
||||
+ content.push({
|
||||
+ type: 'reasoning',
|
||||
+ text: reasoning,
|
||||
+ text: reasoning
|
||||
+ });
|
||||
+ }
|
||||
for (const toolCall of (_a = choice.message.tool_calls) != null ? _a : []) {
|
||||
content.push({
|
||||
type: "tool-call",
|
||||
@@ -866,6 +876,7 @@ var OpenAIChatLanguageModel = class {
|
||||
@@ -866,6 +875,7 @@ var OpenAIChatLanguageModel = class {
|
||||
};
|
||||
let isFirstChunk = true;
|
||||
let metadataExtracted = false;
|
||||
let isActiveText = false;
|
||||
+ let isActiveReasoning = false;
|
||||
const providerMetadata = { openai: {} };
|
||||
return {
|
||||
stream: response.pipeThrough(
|
||||
@@ -920,6 +931,22 @@ var OpenAIChatLanguageModel = class {
|
||||
@@ -923,6 +933,21 @@ var OpenAIChatLanguageModel = class {
|
||||
return;
|
||||
}
|
||||
const delta = choice.delta;
|
||||
@@ -54,7 +53,6 @@ index cc6652c4e7f32878a64a2614115bf7eeb3b7c890..76e989017549c89b45d633525efb1f31
|
||||
+ });
|
||||
+ isActiveReasoning = true;
|
||||
+ }
|
||||
+
|
||||
+ controller.enqueue({
|
||||
+ type: 'reasoning-delta',
|
||||
+ id: 'reasoning-0',
|
||||
@@ -64,7 +62,7 @@ index cc6652c4e7f32878a64a2614115bf7eeb3b7c890..76e989017549c89b45d633525efb1f31
|
||||
if (delta.content != null) {
|
||||
if (!isActiveText) {
|
||||
controller.enqueue({ type: "text-start", id: "0" });
|
||||
@@ -1032,6 +1059,9 @@ var OpenAIChatLanguageModel = class {
|
||||
@@ -1035,6 +1060,9 @@ var OpenAIChatLanguageModel = class {
|
||||
}
|
||||
},
|
||||
flush(controller) {
|
||||
@@ -1,5 +1,5 @@
|
||||
diff --git a/sdk.mjs b/sdk.mjs
|
||||
index 10162e5b1624f8ce667768943347a6e41089ad2f..32568ae08946590e382270c88d85fba81187568e 100755
|
||||
index 8cc6aaf0b25bcdf3c579ec95cde12d419fcb2a71..3b3b8beaea5ad2bbac26a15f792058306d0b059f 100755
|
||||
--- a/sdk.mjs
|
||||
+++ b/sdk.mjs
|
||||
@@ -6213,7 +6213,7 @@ function createAbortController(maxListeners = DEFAULT_MAX_LISTENERS) {
|
||||
@@ -11,7 +11,7 @@ index 10162e5b1624f8ce667768943347a6e41089ad2f..32568ae08946590e382270c88d85fba8
|
||||
import { createInterface } from "readline";
|
||||
|
||||
// ../src/utils/fsOperations.ts
|
||||
@@ -6487,14 +6487,11 @@ class ProcessTransport {
|
||||
@@ -6505,14 +6505,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?`;
|
||||
throw new ReferenceError(errorMessage);
|
||||
}
|
||||
@@ -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
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;
|
||||
}
|
||||
118
CLAUDE.md
118
CLAUDE.md
@@ -7,12 +7,11 @@ This file provides guidance to AI coding assistants when working with code in th
|
||||
- **Keep it clear**: Write code that is easy to read, maintain, and explain.
|
||||
- **Match the house style**: Reuse existing patterns, naming, and conventions.
|
||||
- **Search smart**: Prefer `ast-grep` for semantic queries; fall back to `rg`/`grep` when needed.
|
||||
- **Build with HeroUI**: Use HeroUI for every new UI component; never add `antd` or `styled-components`.
|
||||
- **Build with Tailwind CSS & Shadcn UI**: Use components from `@packages/ui` (Shadcn UI + Tailwind CSS) for every new UI component; never add `antd` or `styled-components`.
|
||||
- **Log centrally**: Route all logging through `loggerService` with the right context—no `console.log`.
|
||||
- **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.
|
||||
- **Write conventional commits with emoji**: Commit small, focused changes using emoji-prefixed 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:`).
|
||||
|
||||
## Development Commands
|
||||
|
||||
@@ -36,14 +35,113 @@ This file provides guidance to AI coding assistants when working with code in th
|
||||
- **Renderer Process** (`src/renderer/`): React UI with Redux state management
|
||||
- **Preload Scripts** (`src/preload/`): Secure IPC bridge
|
||||
|
||||
### Key Components
|
||||
- **AI Core** (`src/renderer/src/aiCore/`): Middleware pipeline for multiple AI providers.
|
||||
- **Services** (`src/main/services/`): MCPService, KnowledgeService, WindowService, etc.
|
||||
- **Build System**: Electron-Vite with experimental rolldown-vite, yarn workspaces.
|
||||
- **State Management**: Redux Toolkit (`src/renderer/src/store/`) for predictable state.
|
||||
- **UI Components**: HeroUI (`@heroui/*`) for all new UI elements.
|
||||
### Key Architectural Components
|
||||
|
||||
#### Main Process Services (`src/main/services/`)
|
||||
|
||||
- **MCPService**: Model Context Protocol server management
|
||||
- **KnowledgeService**: Document processing and knowledge base management
|
||||
- **FileStorage/S3Storage/WebDav**: Multiple storage backends
|
||||
- **WindowService**: Multi-window management (main, mini, selection windows)
|
||||
- **ProxyManager**: Network proxy handling
|
||||
- **SearchService**: Full-text search capabilities
|
||||
|
||||
#### AI Core (`src/renderer/src/aiCore/`)
|
||||
|
||||
- **Middleware System**: Composable pipeline for AI request processing
|
||||
- **Client Factory**: Supports multiple AI providers (OpenAI, Anthropic, Gemini, etc.)
|
||||
- **Stream Processing**: Real-time response handling
|
||||
|
||||
#### Data Management
|
||||
|
||||
- **Cache System**: Three-layer caching (memory/shared/persist) with React hooks integration
|
||||
- **Preferences**: Type-safe configuration management with multi-window synchronization
|
||||
- **User Data**: SQLite-based storage with Drizzle ORM for business data
|
||||
|
||||
#### Knowledge Management
|
||||
|
||||
- **Embeddings**: Vector search with multiple providers (OpenAI, Voyage, etc.)
|
||||
- **OCR**: Document text extraction (system OCR, Doc2x, Mineru)
|
||||
- **Preprocessing**: Document preparation pipeline
|
||||
- **Loaders**: Support for various file formats (PDF, DOCX, EPUB, etc.)
|
||||
|
||||
### Build System
|
||||
|
||||
- **Electron-Vite**: Development and build tooling (v4.0.0)
|
||||
- **Rolldown-Vite**: Using experimental rolldown-vite instead of standard vite
|
||||
- **Workspaces**: Monorepo structure with `packages/` directory
|
||||
- **Multiple Entry Points**: Main app, mini window, selection toolbar
|
||||
- **Styled Components**: CSS-in-JS styling with SWC optimization
|
||||
|
||||
### Testing Strategy
|
||||
|
||||
- **Vitest**: Unit and integration testing
|
||||
- **Playwright**: End-to-end testing
|
||||
- **Component Testing**: React Testing Library
|
||||
- **Coverage**: Available via `yarn test:coverage`
|
||||
|
||||
### Key Patterns
|
||||
|
||||
- **IPC Communication**: Secure main-renderer communication via preload scripts
|
||||
- **Service Layer**: Clear separation between UI and business logic
|
||||
- **Plugin Architecture**: Extensible via MCP servers and middleware
|
||||
- **Multi-language Support**: i18n with dynamic loading
|
||||
- **Theme System**: Light/dark themes with custom CSS variables
|
||||
|
||||
### UI Design
|
||||
|
||||
The project is in the process of migrating from antd & styled-components to Tailwind CSS and Shadcn UI. Please use components from `@packages/ui` to build UI components. The use of antd and styled-components is prohibited.
|
||||
|
||||
UI Library: `@packages/ui`
|
||||
|
||||
### Database Architecture
|
||||
|
||||
- **Database**: SQLite (`cherrystudio.sqlite`) + libsql driver
|
||||
- **ORM**: Drizzle ORM with comprehensive migration system
|
||||
- **Schemas**: Located in `src/main/data/db/schemas/` directory
|
||||
|
||||
#### Database Standards
|
||||
|
||||
- **Table Naming**: Use singular form with snake_case (e.g., `topic`, `message`, `app_state`)
|
||||
- **Schema Exports**: Export using `xxxTable` pattern (e.g., `topicTable`, `appStateTable`)
|
||||
- **Field Definition**: Drizzle auto-infers field names, no need to add default field names
|
||||
- **JSON Fields**: For JSON support, add `{ mode: 'json' }`, refer to `preference.ts` table definition
|
||||
- **JSON Serialization**: For JSON fields, no need to manually serialize/deserialize when reading/writing to database, Drizzle handles this automatically
|
||||
- **Timestamps**: Use existing `crudTimestamps` utility
|
||||
- **Migrations**: Generate via `yarn run migrations:generate`
|
||||
|
||||
## Data Access Patterns
|
||||
|
||||
The application uses three distinct data management systems. Choose the appropriate system based on data characteristics:
|
||||
|
||||
### Cache System
|
||||
- **Purpose**: Temporary data that can be regenerated
|
||||
- **Lifecycle**: Component-level (memory), window-level (shared), or persistent (survives restart)
|
||||
- **Use Cases**: API response caching, computed results, temporary UI state
|
||||
- **APIs**: `useCache`, `useSharedCache`, `usePersistCache` hooks, or `cacheService`
|
||||
|
||||
### Preference System
|
||||
- **Purpose**: User configuration and application settings
|
||||
- **Lifecycle**: Permanent until user changes
|
||||
- **Use Cases**: Theme, language, editor settings, user preferences
|
||||
- **APIs**: `usePreference`, `usePreferences` hooks, or `preferenceService`
|
||||
|
||||
### User Data API
|
||||
- **Purpose**: Core business data (conversations, files, notes, etc.)
|
||||
- **Lifecycle**: Permanent business records
|
||||
- **Use Cases**: Topics, messages, files, knowledge base, user-generated content
|
||||
- **APIs**: `useDataApi` hook or `dataApiService` for direct calls
|
||||
|
||||
### Selection Guidelines
|
||||
|
||||
- **Use Cache** for data that can be lost without impact (computed values, API responses)
|
||||
- **Use Preferences** for user settings that affect app behavior (UI configuration, feature flags)
|
||||
- **Use User Data API** for irreplaceable business data (conversations, documents, user content)
|
||||
|
||||
## Logging Standards
|
||||
|
||||
### Usage
|
||||
|
||||
### Logging
|
||||
```typescript
|
||||
import { loggerService } from '@logger'
|
||||
const logger = loggerService.withContext('moduleName')
|
||||
|
||||
12
README.md
12
README.md
@@ -82,7 +82,7 @@ Cherry Studio is a desktop client that supports multiple LLM providers, availabl
|
||||
1. **Diverse LLM Provider Support**:
|
||||
|
||||
- ☁️ Major LLM Cloud Services: OpenAI, Gemini, Anthropic, and more
|
||||
- 🔗 AI Web Service Integration: Claude, Perplexity, Poe, and others
|
||||
- 🔗 AI Web Service Integration: Claude, Perplexity, [Poe](https://poe.com/), and others
|
||||
- 💻 Local Model Support with Ollama, LM Studio
|
||||
|
||||
2. **AI Assistants & Conversations**:
|
||||
@@ -238,10 +238,6 @@ The Enterprise Edition addresses core challenges in team collaboration by centra
|
||||
|
||||
## ✨ Online Demo
|
||||
|
||||
> 🚧 **Public Beta Notice**
|
||||
>
|
||||
> The Enterprise Edition is currently in its early public beta stage, and we are actively iterating and optimizing its features. We are aware that it may not be perfectly stable yet. If you encounter any issues or have valuable suggestions during your trial, we would be very grateful if you could contact us via email to provide feedback.
|
||||
|
||||
**🔗 [Cherry Studio Enterprise](https://www.cherry-ai.com/enterprise)**
|
||||
|
||||
## Version Comparison
|
||||
@@ -249,7 +245,7 @@ The Enterprise Edition addresses core challenges in team collaboration by centra
|
||||
| Feature | Community Edition | Enterprise Edition |
|
||||
| :---------------- | :----------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| **Open Source** | ✅ Yes | ⭕️ Partially released to customers |
|
||||
| **Cost** | Free for Personal Use / Commercial License | Buyout / Subscription Fee |
|
||||
| **Cost** | [AGPL-3.0 License](https://github.com/CherryHQ/cherry-studio?tab=AGPL-3.0-1-ov-file) | Buyout / Subscription Fee |
|
||||
| **Admin Backend** | — | ● Centralized **Model** Access<br>● **Employee** Management<br>● Shared **Knowledge Base**<br>● **Access** Control<br>● **Data** Backup |
|
||||
| **Server** | — | ✅ Dedicated Private Deployment |
|
||||
|
||||
@@ -262,8 +258,12 @@ We believe the Enterprise Edition will become your team's AI productivity engine
|
||||
|
||||
# 🔗 Related Projects
|
||||
|
||||
- [new-api](https://github.com/QuantumNous/new-api): The next-generation LLM gateway and AI asset management system supports multiple languages.
|
||||
|
||||
- [one-api](https://github.com/songquanpeng/one-api): LLM API management and distribution system supporting mainstream models like OpenAI, Azure, and Anthropic. Features a unified API interface, suitable for key management and secondary distribution.
|
||||
|
||||
- [Poe](https://poe.com/): Poe gives you access to the best AI, all in one place. Explore GPT-5, Claude Opus 4.1, DeepSeek-R1, Veo 3, ElevenLabs, and millions of others.
|
||||
|
||||
- [ublacklist](https://github.com/iorate/ublacklist): Blocks specific sites from appearing in Google search results
|
||||
|
||||
# 🚀 Contributors
|
||||
|
||||
49
app-upgrade-config.json
Normal file
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,
|
||||
"includes": ["**/*.json", "!*.json", "!**/package.json"]
|
||||
"includes": ["**/*.json", "!*.json", "!**/package.json", "!packages/**/*.json"]
|
||||
},
|
||||
"css": {
|
||||
"formatter": {
|
||||
@@ -42,6 +42,7 @@
|
||||
"!.github/**",
|
||||
"!.husky/**",
|
||||
"!.vscode/**",
|
||||
"!.claude/**",
|
||||
"!*.yaml",
|
||||
"!*.yml",
|
||||
"!*.mjs",
|
||||
|
||||
81
config/app-upgrade-segments.json
Normal file
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}}"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -18,13 +18,13 @@ yarn
|
||||
|
||||
### Setup Node.js
|
||||
|
||||
Download and install [Node.js v20.x.x](https://nodejs.org/en/download)
|
||||
Download and install [Node.js v22.x.x](https://nodejs.org/en/download)
|
||||
|
||||
### Setup Yarn
|
||||
|
||||
```bash
|
||||
corepack enable
|
||||
corepack prepare yarn@4.6.0 --activate
|
||||
corepack prepare yarn@4.9.1 --activate
|
||||
```
|
||||
|
||||
### Install Dependencies
|
||||
|
||||
430
docs/technical/app-upgrade-config-en.md
Normal file
430
docs/technical/app-upgrade-config-en.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
|
||||
430
docs/technical/app-upgrade-config-zh.md
Normal file
430
docs/technical/app-upgrade-config-zh.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 测试和灰度发布
|
||||
- 支持配置文件的本地缓存和过期策略
|
||||
@@ -11,6 +11,8 @@ The Test Plan is divided into the RC channel and the Beta channel, with the foll
|
||||
|
||||
Users can enable the "Test Plan" and select the version channel in the software's `Settings` > `About`. Please note that the versions in the "Test Plan" cannot guarantee data consistency, so be sure to back up your data before using them.
|
||||
|
||||
After enabling the RC channel or Beta channel, if a stable version is released, users will still be upgraded to the stable version.
|
||||
|
||||
Users are welcome to submit issues or provide feedback through other channels for any bugs encountered during testing. Your feedback is very important to us.
|
||||
|
||||
## Developer Guide
|
||||
|
||||
@@ -11,6 +11,8 @@
|
||||
|
||||
用户可以在软件的`设置`-`关于`中,开启“测试计划”并选择版本通道。请注意“测试计划”的版本无法保证数据的一致性,请使用前一定要备份数据。
|
||||
|
||||
用户选择RC版通道或Beta版通道后,若发布了正式版,仍旧会升级到正式版。
|
||||
|
||||
用户在测试过程中发现的BUG,欢迎提交issue或通过其他渠道反馈。用户的反馈对我们非常重要。
|
||||
|
||||
## 开发者指南
|
||||
|
||||
@@ -66,9 +66,10 @@ asarUnpack:
|
||||
- resources/**
|
||||
- "**/*.{metal,exp,lib}"
|
||||
- "node_modules/@img/sharp-libvips-*/**"
|
||||
|
||||
# copy from node_modules/claude-code-plugins/plugins to resources/data/claude-code-pluginso
|
||||
extraResources:
|
||||
- from: "migrations/sqlite-drizzle"
|
||||
to: "migrations/sqlite-drizzle"
|
||||
# copy from node_modules/claude-code-plugins/plugins to resources/data/claude-code-pluginso
|
||||
- from: "./node_modules/claude-code-plugins/plugins/"
|
||||
to: "claude-code-plugins"
|
||||
|
||||
@@ -97,7 +98,6 @@ mac:
|
||||
entitlementsInherit: build/entitlements.mac.plist
|
||||
notarize: false
|
||||
artifactName: ${productName}-${version}-${arch}.${ext}
|
||||
minimumSystemVersion: "20.1.0" # 最低支持 macOS 11.0
|
||||
extendInfo:
|
||||
- NSCameraUsageDescription: Application requests access to the device's camera.
|
||||
- NSMicrophoneUsageDescription: Application requests access to the device's microphone.
|
||||
@@ -135,128 +135,58 @@ artifactBuildCompleted: scripts/artifact-build-completed.js
|
||||
releaseInfo:
|
||||
releaseNotes: |
|
||||
<!--LANG:en-->
|
||||
What's New in v1.7.0-beta.3
|
||||
What's New in v1.7.0-rc.1
|
||||
|
||||
New Features:
|
||||
- Enhanced Tool Permission System: Real-time tool approval interface with improved UX
|
||||
- Plugin Management System: Support for Claude Agent plugins (agents, commands, skills)
|
||||
- Skill Tool: Add skill execution capabilities for agents
|
||||
- Mobile App Data Restore: Support restoring data to mobile applications
|
||||
- OpenMinerU Preprocessor: Knowledge base now supports open-source MinerU for document processing
|
||||
- HuggingFace Provider: Added HuggingFace as AI provider
|
||||
- Claude Haiku 4.5: Support for the latest Claude Haiku 4.5 model
|
||||
- Ling Series Models: Added support for Ling-1T and related models
|
||||
- Intel OVMS Painting: New painting provider using Intel OpenVINO Model Server
|
||||
- Automatic Update Checks: Implement periodic update checking with configurable intervals
|
||||
- HuggingChat Mini App: New mini app for HuggingChat integration
|
||||
🎉 MAJOR NEW FEATURE: AI Agents
|
||||
- Create and manage custom AI agents with specialized tools and permissions
|
||||
- Dedicated agent sessions with persistent SQLite storage, separate from regular chats
|
||||
- Real-time tool approval system - review and approve agent actions dynamically
|
||||
- MCP (Model Context Protocol) integration for connecting external tools
|
||||
- Slash commands support for quick agent interactions
|
||||
- OpenAI-compatible REST API for agent access
|
||||
|
||||
Improvements:
|
||||
- Agent Creation: New agents are now automatically activated upon creation
|
||||
- Lazy Loading: Optimize page load performance with route lazy loading
|
||||
- UI Enhancements: Improved agent item styling and layout consistency
|
||||
- Navigation: Better navbar layout for fullscreen mode on macOS
|
||||
- Settings Tab: Enhanced context slider consistency
|
||||
- Backup Manager: Unified footer layout for local and S3 backup managers
|
||||
- Menu System: Enhanced application menu with improved help section
|
||||
- Proxy Rules: Comprehensive proxy bypass rule matching
|
||||
- German Language: Added German language support
|
||||
- MCP Confirmation: Added confirmation modal when activating protocol-installed MCP servers
|
||||
- Translation: Enhanced translation script with concurrency and validation
|
||||
- Electron & Vite: Updated to Electron 38 and Vite 4.0.1
|
||||
- QR Code Generation: Optimized performance for phone LAN export
|
||||
- Enterprise Settings: Added enterprise section in About settings
|
||||
- Assistant/Agent Popup: Enhanced UI for adding assistants and agents
|
||||
✨ New Features:
|
||||
- AI Providers: Added support for Hugging Face, Mistral, Perplexity, and SophNet
|
||||
- Knowledge Base: OpenMinerU document preprocessor, full-text search in notes, enhanced tool selection
|
||||
- Image & OCR: Intel OVMS painting provider and Intel OpenVINO (NPU) OCR support
|
||||
- MCP Management: Redesigned interface with dual-column layout for easier management
|
||||
- Languages: Added German language support
|
||||
|
||||
Claude Code Tool Improvements:
|
||||
- GlobTool: Now counts lines instead of files in output for better clarity
|
||||
- ReadTool: Automatically removes system reminder tags from output
|
||||
- TodoWriteTool: Improved rendering behavior
|
||||
- Environment Variables: Updated model-related environment variable names
|
||||
⚡ Improvements:
|
||||
- Upgraded to Electron 38.7.0
|
||||
- Enhanced system shutdown handling and automatic update checks
|
||||
- Improved proxy bypass rules
|
||||
|
||||
Bug Fixes:
|
||||
- Fixed session model not being used when sending messages
|
||||
- Fixed tool approval UI and shared workspace plugin inconsistencies
|
||||
- Fixed API server readiness notification to renderer
|
||||
- Fixed grouped items not respecting saved tag order
|
||||
- Fixed assistant/agent activation when creating new ones
|
||||
- Fixed Dashscope Anthropic API host and migrated old configs
|
||||
- Fixed Qwen3 thinking mode control for Ollama
|
||||
- Fixed disappeared MCP button
|
||||
- Fixed create assistant causing blank screen
|
||||
- Fixed up-down button visibility in some cases
|
||||
- Fixed hooks preventing save on composing enter key
|
||||
- Fixed Azure GPT-image-1 and OpenRouter Gemini-image
|
||||
- Fixed Silicon reasoning issues
|
||||
- Fixed topic branch incomplete copy with two-pass ID mapping
|
||||
- Fixed deep research model search context restrictions
|
||||
- Fixed model capability checking logic
|
||||
- Fixed reranker API error response capture
|
||||
- Fixed right-click paste file content into inputbar
|
||||
- Fixed minimax-m2 support in aiCore
|
||||
- Fixed Azure embedding issues
|
||||
- Fixed agent edit modal loading race condition
|
||||
- Fixed debounced save cancellation on file path update
|
||||
🐛 Important Bug Fixes:
|
||||
- Fixed streaming response issues across multiple AI providers
|
||||
- Fixed session list scrolling problems
|
||||
- Fixed knowledge base deletion errors
|
||||
|
||||
<!--LANG:zh-CN-->
|
||||
v1.7.0-beta.3 新特性
|
||||
v1.7.0-rc.1 新特性
|
||||
|
||||
新功能:
|
||||
- 增强工具权限系统:实时工具审批界面,改进用户体验
|
||||
- 插件管理系统:支持 Claude Agent 插件(agents、commands、skills)
|
||||
- 技能工具:为 Agent 添加技能执行能力
|
||||
- 移动应用数据恢复:支持将数据恢复到移动应用程序
|
||||
- OpenMinerU 预处理器:知识库现支持使用开源 MinerU 处理文档
|
||||
- HuggingFace 提供商:添加 HuggingFace 作为 AI 提供商
|
||||
- Claude Haiku 4.5:支持最新的 Claude Haiku 4.5 模型
|
||||
- Ling 系列模型:添加 Ling-1T 及相关模型支持
|
||||
- Intel OVMS 绘图:使用 Intel OpenVINO 模型服务器的新绘图提供商
|
||||
- 自动更新检查:实现可配置间隔的定期更新检查
|
||||
- HuggingChat 小程序:新增 HuggingChat 集成小程序
|
||||
🎉 重大更新:AI Agent 智能体系统
|
||||
- 创建和管理专属 AI Agent,配置专用工具和权限
|
||||
- 独立的 Agent 会话,使用 SQLite 持久化存储,与普通聊天分离
|
||||
- 实时工具审批系统 - 动态审查和批准 Agent 操作
|
||||
- MCP(模型上下文协议)集成,连接外部工具
|
||||
- 支持斜杠命令快速交互
|
||||
- 兼容 OpenAI 的 REST API 访问
|
||||
|
||||
改进:
|
||||
- Agent 创建:新创建的 Agent 现在会自动激活
|
||||
- 懒加载:通过路由懒加载优化页面加载性能
|
||||
- UI 增强:改进 Agent 项目样式和布局一致性
|
||||
- 导航:改进 macOS 全屏模式下的导航栏布局
|
||||
- 设置选项卡:增强上下文滑块一致性
|
||||
- 备份管理器:统一本地和 S3 备份管理器的页脚布局
|
||||
- 菜单系统:增强应用菜单,改进帮助部分
|
||||
- 代理规则:全面的代理绕过规则匹配
|
||||
- 德语支持:添加德语语言支持
|
||||
- MCP 确认:添加激活协议安装的 MCP 服务器时的确认模态框
|
||||
- 翻译:增强翻译脚本的并发和验证功能
|
||||
- Electron & Vite:更新至 Electron 38 和 Vite 4.0.1
|
||||
- 二维码生成:优化手机局域网导出性能
|
||||
- 企业设置:在关于设置中添加企业部分
|
||||
- 助手/Agent 弹窗:增强添加助手和 Agent 的界面
|
||||
✨ 新功能:
|
||||
- AI 提供商:新增 Hugging Face、Mistral、Perplexity 和 SophNet 支持
|
||||
- 知识库:OpenMinerU 文档预处理器、笔记全文搜索、增强的工具选择
|
||||
- 图像与 OCR:Intel OVMS 绘图提供商和 Intel OpenVINO (NPU) OCR 支持
|
||||
- MCP 管理:重构管理界面,采用双列布局,更加方便管理
|
||||
- 语言:新增德语支持
|
||||
|
||||
Claude Code 工具改进:
|
||||
- GlobTool:现在计算行数而不是文件数,提供更清晰的输出
|
||||
- ReadTool:自动从输出中移除系统提醒标签
|
||||
- TodoWriteTool:改进渲染行为
|
||||
- 环境变量:更新模型相关的环境变量名称
|
||||
⚡ 改进:
|
||||
- 升级到 Electron 38.7.0
|
||||
- 增强的系统关机处理和自动更新检查
|
||||
- 改进的代理绕过规则
|
||||
|
||||
问题修复:
|
||||
- 修复发送消息时未使用会话模型
|
||||
- 修复工具审批 UI 和共享工作区插件不一致
|
||||
- 修复 API 服务器就绪通知到渲染器
|
||||
- 修复分组项目不遵守已保存标签顺序
|
||||
- 修复创建新的助手/Agent 时的激活问题
|
||||
- 修复 Dashscope Anthropic API 主机并迁移旧配置
|
||||
- 修复 Ollama 的 Qwen3 思考模式控制
|
||||
- 修复 MCP 按钮消失
|
||||
- 修复创建助手导致空白屏幕
|
||||
- 修复某些情况下上下按钮可见性
|
||||
- 修复钩子在输入法输入时阻止保存
|
||||
- 修复 Azure GPT-image-1 和 OpenRouter Gemini-image
|
||||
- 修复 Silicon 推理问题
|
||||
- 修复主题分支不完整复制,采用两阶段 ID 映射
|
||||
- 修复深度研究模型搜索上下文限制
|
||||
- 修复模型能力检查逻辑
|
||||
- 修复 reranker API 错误响应捕获
|
||||
- 修复右键粘贴文件内容到输入栏
|
||||
- 修复 aiCore 中的 minimax-m2 支持
|
||||
- 修复 Azure embedding 问题
|
||||
- 修复 Agent 编辑模态框加载竞态条件
|
||||
- 修复文件路径更新时防抖保存取消问题
|
||||
🐛 重要修复:
|
||||
- 修复多个 AI 提供商的流式响应问题
|
||||
- 修复会话列表滚动问题
|
||||
- 修复知识库删除错误
|
||||
<!--LANG:END-->
|
||||
|
||||
@@ -22,6 +22,7 @@ export default defineConfig({
|
||||
alias: {
|
||||
'@main': resolve('src/main'),
|
||||
'@types': resolve('src/renderer/src/types'),
|
||||
'@data': resolve('src/main/data'),
|
||||
'@shared': resolve('packages/shared'),
|
||||
'@logger': resolve('src/main/services/LoggerService'),
|
||||
'@mcp-trace/trace-core': resolve('packages/mcp-trace/trace-core'),
|
||||
@@ -61,7 +62,20 @@ export default defineConfig({
|
||||
}
|
||||
},
|
||||
build: {
|
||||
sourcemap: isDev
|
||||
sourcemap: isDev,
|
||||
rollupOptions: {
|
||||
// Unlike renderer which auto-discovers entries from HTML files,
|
||||
// preload requires explicit entry point configuration for multiple scripts
|
||||
input: {
|
||||
index: resolve(__dirname, 'src/preload/index.ts'),
|
||||
simplest: resolve(__dirname, 'src/preload/simplest.ts') // Minimal preload
|
||||
},
|
||||
external: ['electron'],
|
||||
output: {
|
||||
entryFileNames: '[name].js',
|
||||
format: 'cjs'
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
renderer: {
|
||||
@@ -90,12 +104,17 @@ export default defineConfig({
|
||||
'@shared': resolve('packages/shared'),
|
||||
'@types': resolve('src/renderer/src/types'),
|
||||
'@logger': resolve('src/renderer/src/services/LoggerService'),
|
||||
'@data': resolve('src/renderer/src/data'),
|
||||
'@mcp-trace/trace-core': resolve('packages/mcp-trace/trace-core'),
|
||||
'@mcp-trace/trace-web': resolve('packages/mcp-trace/trace-web'),
|
||||
'@cherrystudio/ai-core/provider': resolve('packages/aiCore/src/core/providers'),
|
||||
'@cherrystudio/ai-core/built-in/plugins': resolve('packages/aiCore/src/core/plugins/built-in'),
|
||||
'@cherrystudio/ai-core': resolve('packages/aiCore/src'),
|
||||
'@cherrystudio/extension-table-plus': resolve('packages/extension-table-plus/src')
|
||||
'@cherrystudio/extension-table-plus': resolve('packages/extension-table-plus/src'),
|
||||
'@cherrystudio/ai-sdk-provider': resolve('packages/ai-sdk-provider/src'),
|
||||
'@cherrystudio/ui/icons': resolve('packages/ui/src/components/icons'),
|
||||
'@cherrystudio/ui': resolve('packages/ui/src'),
|
||||
'@cherrystudio/catalog': resolve('packages/catalog/src')
|
||||
}
|
||||
},
|
||||
optimizeDeps: {
|
||||
@@ -115,7 +134,8 @@ export default defineConfig({
|
||||
miniWindow: resolve(__dirname, 'src/renderer/miniWindow.html'),
|
||||
selectionToolbar: resolve(__dirname, 'src/renderer/selectionToolbar.html'),
|
||||
selectionAction: resolve(__dirname, 'src/renderer/selectionAction.html'),
|
||||
traceWindow: resolve(__dirname, 'src/renderer/traceWindow.html')
|
||||
traceWindow: resolve(__dirname, 'src/renderer/traceWindow.html'),
|
||||
migrationV2: resolve(__dirname, 'src/renderer/migrationV2.html')
|
||||
},
|
||||
onwarn(warning, warn) {
|
||||
if (warning.code === 'COMMONJS_VARIABLE_IN_ESM') return
|
||||
|
||||
@@ -72,8 +72,9 @@ export default defineConfig([
|
||||
...oxlint.configs['flat/eslint'],
|
||||
...oxlint.configs['flat/typescript'],
|
||||
...oxlint.configs['flat/unicorn'],
|
||||
// Custom rules should be after oxlint to overwrite
|
||||
// LoggerService Custom Rules - only apply to src directory
|
||||
{
|
||||
// LoggerService Custom Rules - only apply to src directory
|
||||
files: ['src/**/*.{ts,tsx,js,jsx}'],
|
||||
ignores: ['src/**/__tests__/**', 'src/**/__mocks__/**', 'src/**/*.test.*', 'src/preload/**'],
|
||||
rules: {
|
||||
@@ -87,6 +88,7 @@ export default defineConfig([
|
||||
]
|
||||
}
|
||||
},
|
||||
// i18n
|
||||
{
|
||||
files: ['**/*.{ts,tsx,js,jsx}'],
|
||||
languageOptions: {
|
||||
@@ -134,4 +136,25 @@ export default defineConfig([
|
||||
'i18n/no-template-in-t': 'warn'
|
||||
}
|
||||
},
|
||||
// ui migration
|
||||
{
|
||||
// Component Rules - prevent importing antd components when migration completed
|
||||
files: ['**/*.{ts,tsx,js,jsx}'],
|
||||
ignores: [],
|
||||
rules: {
|
||||
// 'no-restricted-imports': [
|
||||
// 'error',
|
||||
// {
|
||||
// paths: [
|
||||
// {
|
||||
// name: 'antd',
|
||||
// importNames: ['Flex', 'Switch', 'message', 'Button', 'Tooltip'],
|
||||
// message:
|
||||
// '❌ Do not import this component from antd. Use our custom components instead: import { ... } from "@cherrystudio/ui"'
|
||||
// }
|
||||
// ]
|
||||
// }
|
||||
// ]
|
||||
}
|
||||
},
|
||||
])
|
||||
|
||||
6
migrations/README.md
Normal file
6
migrations/README.md
Normal file
@@ -0,0 +1,6 @@
|
||||
**THIS DIRECTORY IS NOT FOR RUNTIME USE**
|
||||
|
||||
- Using `libsql` as the `sqlite3` driver, and `drizzle` as the ORM and database migration tool
|
||||
- `migrations/sqlite-drizzle` contains auto-generated migration data. Please **DO NOT** modify it.
|
||||
- If table structure changes, we should run migrations.
|
||||
- To generate migrations, use the command `yarn run migrations:generate`
|
||||
7
migrations/sqlite-drizzle.config.ts
Normal file
7
migrations/sqlite-drizzle.config.ts
Normal file
@@ -0,0 +1,7 @@
|
||||
import { defineConfig } from 'drizzle-kit'
|
||||
export default defineConfig({
|
||||
out: './migrations/sqlite-drizzle',
|
||||
schema: './src/main/data/db/schemas/*',
|
||||
dialect: 'sqlite',
|
||||
casing: 'snake_case'
|
||||
})
|
||||
17
migrations/sqlite-drizzle/0000_solid_lord_hawal.sql
Normal file
17
migrations/sqlite-drizzle/0000_solid_lord_hawal.sql
Normal file
@@ -0,0 +1,17 @@
|
||||
CREATE TABLE `app_state` (
|
||||
`key` text PRIMARY KEY NOT NULL,
|
||||
`value` text NOT NULL,
|
||||
`description` text,
|
||||
`created_at` integer,
|
||||
`updated_at` integer
|
||||
);
|
||||
--> statement-breakpoint
|
||||
CREATE TABLE `preference` (
|
||||
`scope` text NOT NULL,
|
||||
`key` text NOT NULL,
|
||||
`value` text,
|
||||
`created_at` integer,
|
||||
`updated_at` integer
|
||||
);
|
||||
--> statement-breakpoint
|
||||
CREATE INDEX `scope_name_idx` ON `preference` (`scope`,`key`);
|
||||
114
migrations/sqlite-drizzle/meta/0000_snapshot.json
Normal file
114
migrations/sqlite-drizzle/meta/0000_snapshot.json
Normal file
@@ -0,0 +1,114 @@
|
||||
{
|
||||
"_meta": {
|
||||
"columns": {},
|
||||
"schemas": {},
|
||||
"tables": {}
|
||||
},
|
||||
"dialect": "sqlite",
|
||||
"enums": {},
|
||||
"id": "de8009d7-95b9-4f99-99fa-4b8795708f21",
|
||||
"internal": {
|
||||
"indexes": {}
|
||||
},
|
||||
"prevId": "00000000-0000-0000-0000-000000000000",
|
||||
"tables": {
|
||||
"app_state": {
|
||||
"checkConstraints": {},
|
||||
"columns": {
|
||||
"created_at": {
|
||||
"autoincrement": false,
|
||||
"name": "created_at",
|
||||
"notNull": false,
|
||||
"primaryKey": false,
|
||||
"type": "integer"
|
||||
},
|
||||
"description": {
|
||||
"autoincrement": false,
|
||||
"name": "description",
|
||||
"notNull": false,
|
||||
"primaryKey": false,
|
||||
"type": "text"
|
||||
},
|
||||
"key": {
|
||||
"autoincrement": false,
|
||||
"name": "key",
|
||||
"notNull": true,
|
||||
"primaryKey": true,
|
||||
"type": "text"
|
||||
},
|
||||
"updated_at": {
|
||||
"autoincrement": false,
|
||||
"name": "updated_at",
|
||||
"notNull": false,
|
||||
"primaryKey": false,
|
||||
"type": "integer"
|
||||
},
|
||||
"value": {
|
||||
"autoincrement": false,
|
||||
"name": "value",
|
||||
"notNull": true,
|
||||
"primaryKey": false,
|
||||
"type": "text"
|
||||
}
|
||||
},
|
||||
"compositePrimaryKeys": {},
|
||||
"foreignKeys": {},
|
||||
"indexes": {},
|
||||
"name": "app_state",
|
||||
"uniqueConstraints": {}
|
||||
},
|
||||
"preference": {
|
||||
"checkConstraints": {},
|
||||
"columns": {
|
||||
"created_at": {
|
||||
"autoincrement": false,
|
||||
"name": "created_at",
|
||||
"notNull": false,
|
||||
"primaryKey": false,
|
||||
"type": "integer"
|
||||
},
|
||||
"key": {
|
||||
"autoincrement": false,
|
||||
"name": "key",
|
||||
"notNull": true,
|
||||
"primaryKey": false,
|
||||
"type": "text"
|
||||
},
|
||||
"scope": {
|
||||
"autoincrement": false,
|
||||
"name": "scope",
|
||||
"notNull": true,
|
||||
"primaryKey": false,
|
||||
"type": "text"
|
||||
},
|
||||
"updated_at": {
|
||||
"autoincrement": false,
|
||||
"name": "updated_at",
|
||||
"notNull": false,
|
||||
"primaryKey": false,
|
||||
"type": "integer"
|
||||
},
|
||||
"value": {
|
||||
"autoincrement": false,
|
||||
"name": "value",
|
||||
"notNull": false,
|
||||
"primaryKey": false,
|
||||
"type": "text"
|
||||
}
|
||||
},
|
||||
"compositePrimaryKeys": {},
|
||||
"foreignKeys": {},
|
||||
"indexes": {
|
||||
"scope_name_idx": {
|
||||
"columns": ["scope", "key"],
|
||||
"isUnique": false,
|
||||
"name": "scope_name_idx"
|
||||
}
|
||||
},
|
||||
"name": "preference",
|
||||
"uniqueConstraints": {}
|
||||
}
|
||||
},
|
||||
"version": "6",
|
||||
"views": {}
|
||||
}
|
||||
13
migrations/sqlite-drizzle/meta/_journal.json
Normal file
13
migrations/sqlite-drizzle/meta/_journal.json
Normal file
@@ -0,0 +1,13 @@
|
||||
{
|
||||
"dialect": "sqlite",
|
||||
"entries": [
|
||||
{
|
||||
"breakpoints": true,
|
||||
"idx": 0,
|
||||
"tag": "0000_solid_lord_hawal",
|
||||
"version": "6",
|
||||
"when": 1754745234572
|
||||
}
|
||||
],
|
||||
"version": "7"
|
||||
}
|
||||
69
package.json
69
package.json
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "CherryStudio",
|
||||
"version": "1.7.0-beta.3",
|
||||
"version": "2.0.0-alpha",
|
||||
"private": true,
|
||||
"description": "A powerful AI assistant for producer.",
|
||||
"main": "./out/main/index.js",
|
||||
@@ -50,14 +50,16 @@
|
||||
"generate:icons": "electron-icon-builder --input=./build/logo.png --output=build",
|
||||
"analyze:renderer": "VISUALIZER_RENDERER=true yarn build",
|
||||
"analyze:main": "VISUALIZER_MAIN=true yarn build",
|
||||
"typecheck": "concurrently -n \"node,web\" -c \"cyan,magenta\" \"npm run typecheck:node\" \"npm run typecheck:web\"",
|
||||
"typecheck": "concurrently -n \"node,web,ui\" -c \"cyan,magenta,green\" \"npm run typecheck:node\" \"npm run typecheck:web\" \"npm run typecheck:ui\"",
|
||||
"typecheck:node": "tsgo --noEmit -p tsconfig.node.json --composite false",
|
||||
"typecheck:web": "tsgo --noEmit -p tsconfig.web.json --composite false",
|
||||
"typecheck:ui": "cd packages/ui && npm run type-check",
|
||||
"check:i18n": "dotenv -e .env -- tsx scripts/check-i18n.ts",
|
||||
"sync:i18n": "dotenv -e .env -- tsx scripts/sync-i18n.ts",
|
||||
"update:i18n": "dotenv -e .env -- tsx scripts/update-i18n.ts",
|
||||
"auto:i18n": "dotenv -e .env -- tsx scripts/auto-translate-i18n.ts",
|
||||
"update:languages": "tsx scripts/update-languages.ts",
|
||||
"update:upgrade-config": "tsx scripts/update-app-upgrade-config.ts",
|
||||
"test": "vitest run --silent",
|
||||
"test:main": "vitest run --project main",
|
||||
"test:renderer": "vitest run --project renderer",
|
||||
@@ -68,21 +70,26 @@
|
||||
"test:e2e": "yarn playwright test",
|
||||
"test:lint": "oxlint --deny-warnings && eslint . --ext .js,.jsx,.cjs,.mjs,.ts,.tsx,.cts,.mts --cache",
|
||||
"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 && biome lint --write && biome format --write && yarn typecheck && yarn check:i18n && yarn format:check",
|
||||
"lint:ox": "oxlint --fix && biome lint --write && biome format --write",
|
||||
"format": "biome format --write && biome lint --write",
|
||||
"format:check": "biome format && biome lint",
|
||||
"prepare": "git config blame.ignoreRevsFile .git-blame-ignore-revs && husky",
|
||||
"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:beta": "yarn workspace @cherrystudio/ai-core version prerelease --immediate && 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"
|
||||
"migrations:generate": "drizzle-kit generate --config ./migrations/sqlite-drizzle.config.ts",
|
||||
"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 --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 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": {
|
||||
"@anthropic-ai/claude-agent-sdk": "patch:@anthropic-ai/claude-agent-sdk@npm%3A0.1.25#~/.yarn/patches/@anthropic-ai-claude-agent-sdk-npm-0.1.25-08bbabb5d3.patch",
|
||||
"@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",
|
||||
"@libsql/client": "0.14.0",
|
||||
"@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",
|
||||
"@paymoapp/electron-shutdown-handler": "^1.1.2",
|
||||
"@strongtz/win32-arm64-msvc": "^0.4.7",
|
||||
"emoji-picker-element-data": "^1",
|
||||
"express": "^5.1.0",
|
||||
"font-list": "^2.0.0",
|
||||
"graceful-fs": "^4.2.11",
|
||||
@@ -96,6 +103,7 @@
|
||||
"selection-hook": "^1.0.12",
|
||||
"sharp": "^0.34.3",
|
||||
"socket.io": "^4.8.1",
|
||||
"stream-json": "^1.9.1",
|
||||
"swagger-jsdoc": "^6.2.8",
|
||||
"swagger-ui-express": "^5.0.1",
|
||||
"tesseract.js": "patch:tesseract.js@npm%3A6.0.1#~/.yarn/patches/tesseract.js-npm-6.0.1-2562a7e46d.patch",
|
||||
@@ -105,11 +113,16 @@
|
||||
"@agentic/exa": "^7.3.3",
|
||||
"@agentic/searxng": "^7.3.3",
|
||||
"@agentic/tavily": "^7.3.3",
|
||||
"@ai-sdk/amazon-bedrock": "^3.0.42",
|
||||
"@ai-sdk/google-vertex": "^3.0.48",
|
||||
"@ai-sdk/huggingface": "patch:@ai-sdk/huggingface@npm%3A0.0.4#~/.yarn/patches/@ai-sdk-huggingface-npm-0.0.4-8080836bc1.patch",
|
||||
"@ai-sdk/mistral": "^2.0.19",
|
||||
"@ai-sdk/perplexity": "^2.0.13",
|
||||
"@ai-sdk/amazon-bedrock": "^3.0.53",
|
||||
"@ai-sdk/anthropic": "^2.0.44",
|
||||
"@ai-sdk/cerebras": "^1.0.31",
|
||||
"@ai-sdk/gateway": "^2.0.9",
|
||||
"@ai-sdk/google": "patch:@ai-sdk/google@npm%3A2.0.36#~/.yarn/patches/@ai-sdk-google-npm-2.0.36-6f3cc06026.patch",
|
||||
"@ai-sdk/google-vertex": "^3.0.68",
|
||||
"@ai-sdk/huggingface": "patch:@ai-sdk/huggingface@npm%3A0.0.8#~/.yarn/patches/@ai-sdk-huggingface-npm-0.0.8-d4d0aaac93.patch",
|
||||
"@ai-sdk/mistral": "^2.0.23",
|
||||
"@ai-sdk/openai": "patch:@ai-sdk/openai@npm%3A2.0.64#~/.yarn/patches/@ai-sdk-openai-npm-2.0.64-48f99f5bf3.patch",
|
||||
"@ai-sdk/perplexity": "^2.0.17",
|
||||
"@ant-design/v5-patch-for-react-19": "^1.0.3",
|
||||
"@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",
|
||||
@@ -117,7 +130,7 @@
|
||||
"@aws-sdk/client-bedrock-runtime": "^3.910.0",
|
||||
"@aws-sdk/client-s3": "^3.910.0",
|
||||
"@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-libsql": "^0.1.31",
|
||||
"@cherrystudio/embedjs-loader-csv": "^0.1.31",
|
||||
@@ -131,7 +144,8 @@
|
||||
"@cherrystudio/embedjs-ollama": "^0.1.31",
|
||||
"@cherrystudio/embedjs-openai": "^0.1.31",
|
||||
"@cherrystudio/extension-table-plus": "workspace:^",
|
||||
"@cherrystudio/openai": "^6.5.0",
|
||||
"@cherrystudio/openai": "^6.9.0",
|
||||
"@cherrystudio/ui": "workspace:*",
|
||||
"@dnd-kit/core": "^6.3.1",
|
||||
"@dnd-kit/modifiers": "^9.0.0",
|
||||
"@dnd-kit/sortable": "^10.0.0",
|
||||
@@ -146,8 +160,6 @@
|
||||
"@eslint/js": "^9.22.0",
|
||||
"@google/genai": "patch:@google/genai@npm%3A1.0.1#~/.yarn/patches/@google-genai-npm-1.0.1-e26f0f9af7.patch",
|
||||
"@hello-pangea/dnd": "^18.0.1",
|
||||
"@heroui/react": "^2.8.3",
|
||||
"@kangfenmao/keyv-storage": "^0.1.0",
|
||||
"@langchain/community": "^1.0.0",
|
||||
"@langchain/core": "patch:@langchain/core@npm%3A1.0.2#~/.yarn/patches/@langchain-core-npm-1.0.2-183ef83fe4.patch",
|
||||
"@langchain/openai": "patch:@langchain/openai@npm%3A1.0.0#~/.yarn/patches/@langchain-openai-npm-1.0.0-474d0ad9d4.patch",
|
||||
@@ -162,7 +174,7 @@
|
||||
"@opentelemetry/sdk-trace-base": "^2.0.0",
|
||||
"@opentelemetry/sdk-trace-node": "^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",
|
||||
"@radix-ui/react-context-menu": "^2.2.16",
|
||||
"@reduxjs/toolkit": "^2.2.5",
|
||||
@@ -213,6 +225,7 @@
|
||||
"@types/react-infinite-scroll-component": "^5.0.0",
|
||||
"@types/react-transition-group": "^4.4.12",
|
||||
"@types/react-window": "^1",
|
||||
"@types/stream-json": "^1",
|
||||
"@types/swagger-jsdoc": "^6",
|
||||
"@types/swagger-ui-express": "^4.1.8",
|
||||
"@types/tinycolor2": "^1",
|
||||
@@ -231,7 +244,7 @@
|
||||
"@viz-js/lang-dot": "^1.0.5",
|
||||
"@viz-js/viz": "^3.14.0",
|
||||
"@xyflow/react": "^12.4.4",
|
||||
"ai": "^5.0.76",
|
||||
"ai": "^5.0.90",
|
||||
"antd": "patch:antd@npm%3A5.27.0#~/.yarn/patches/antd-npm-5.27.0-aa91c36546.patch",
|
||||
"archiver": "^7.0.1",
|
||||
"async-mutex": "^0.5.0",
|
||||
@@ -241,7 +254,7 @@
|
||||
"check-disk-space": "3.4.0",
|
||||
"cheerio": "^1.1.2",
|
||||
"chokidar": "^4.0.3",
|
||||
"claude-code-plugins": "1.0.1",
|
||||
"claude-code-plugins": "1.0.3",
|
||||
"cli-progress": "^3.12.0",
|
||||
"clsx": "^2.1.1",
|
||||
"code-inspector-plugin": "^0.20.14",
|
||||
@@ -257,12 +270,12 @@
|
||||
"dotenv-cli": "^7.4.2",
|
||||
"drizzle-kit": "^0.31.4",
|
||||
"drizzle-orm": "^0.44.5",
|
||||
"electron": "38.4.0",
|
||||
"electron-builder": "26.0.15",
|
||||
"electron": "38.7.0",
|
||||
"electron-builder": "26.1.0",
|
||||
"electron-devtools-installer": "^3.2.0",
|
||||
"electron-reload": "^2.0.0-alpha.1",
|
||||
"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-window-state": "^5.0.3",
|
||||
"emittery": "^1.0.3",
|
||||
@@ -348,6 +361,7 @@
|
||||
"striptags": "^3.2.0",
|
||||
"styled-components": "^6.1.11",
|
||||
"swr": "^2.3.6",
|
||||
"tailwind-merge": "^3.3.1",
|
||||
"tailwindcss": "^4.1.13",
|
||||
"tar": "^7.4.3",
|
||||
"tiny-pinyin": "^1.3.2",
|
||||
@@ -373,17 +387,16 @@
|
||||
"zod": "^4.1.5"
|
||||
},
|
||||
"resolutions": {
|
||||
"@smithy/types": "4.7.1",
|
||||
"@codemirror/language": "6.11.3",
|
||||
"@codemirror/lint": "6.8.5",
|
||||
"@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",
|
||||
"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",
|
||||
"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",
|
||||
"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.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",
|
||||
@@ -392,7 +405,6 @@
|
||||
"undici": "6.21.2",
|
||||
"vite": "npm:rolldown-vite@7.1.5",
|
||||
"tesseract.js@npm:*": "patch:tesseract.js@npm%3A6.0.1#~/.yarn/patches/tesseract.js-npm-6.0.1-2562a7e46d.patch",
|
||||
"@ai-sdk/google@npm:2.0.23": "patch:@ai-sdk/google@npm%3A2.0.23#~/.yarn/patches/@ai-sdk-google-npm-2.0.23-81682e07b0.patch",
|
||||
"@ai-sdk/openai@npm:^2.0.52": "patch:@ai-sdk/openai@npm%3A2.0.52#~/.yarn/patches/@ai-sdk-openai-npm-2.0.52-b36d949c76.patch",
|
||||
"@img/sharp-darwin-arm64": "0.34.3",
|
||||
"@img/sharp-darwin-x64": "0.34.3",
|
||||
@@ -403,7 +415,10 @@
|
||||
"openai@npm:5.12.2": "npm:@cherrystudio/openai@6.5.0",
|
||||
"@langchain/openai@npm:>=0.1.0 <0.6.0": "patch:@langchain/openai@npm%3A1.0.0#~/.yarn/patches/@langchain-openai-npm-1.0.0-474d0ad9d4.patch",
|
||||
"@langchain/openai@npm:^0.3.16": "patch:@langchain/openai@npm%3A1.0.0#~/.yarn/patches/@langchain-openai-npm-1.0.0-474d0ad9d4.patch",
|
||||
"@langchain/openai@npm:>=0.2.0 <0.7.0": "patch:@langchain/openai@npm%3A1.0.0#~/.yarn/patches/@langchain-openai-npm-1.0.0-474d0ad9d4.patch"
|
||||
"@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.64#~/.yarn/patches/@ai-sdk-openai-npm-2.0.64-48f99f5bf3.patch",
|
||||
"@ai-sdk/google@npm:2.0.36": "patch:@ai-sdk/google@npm%3A2.0.36#~/.yarn/patches/@ai-sdk-google-npm-2.0.36-6f3cc06026.patch"
|
||||
},
|
||||
"packageManager": "yarn@4.9.1",
|
||||
"lint-staged": {
|
||||
|
||||
39
packages/ai-sdk-provider/README.md
Normal file
39
packages/ai-sdk-provider/README.md
Normal file
@@ -0,0 +1,39 @@
|
||||
# @cherrystudio/ai-sdk-provider
|
||||
|
||||
CherryIN provider bundle for the [Vercel AI SDK](https://ai-sdk.dev/).
|
||||
It exposes the CherryIN OpenAI-compatible entrypoints and dynamically routes Anthropic and Gemini model ids to their CherryIN upstream equivalents.
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
npm install ai @cherrystudio/ai-sdk-provider @ai-sdk/anthropic @ai-sdk/google @ai-sdk/openai
|
||||
# or
|
||||
yarn add ai @cherrystudio/ai-sdk-provider @ai-sdk/anthropic @ai-sdk/google @ai-sdk/openai
|
||||
```
|
||||
|
||||
> **Note**: This package requires peer dependencies `ai`, `@ai-sdk/anthropic`, `@ai-sdk/google`, and `@ai-sdk/openai` to be installed.
|
||||
|
||||
## Usage
|
||||
|
||||
```ts
|
||||
import { createCherryIn, cherryIn } from '@cherrystudio/ai-sdk-provider'
|
||||
|
||||
const cherryInProvider = createCherryIn({
|
||||
apiKey: process.env.CHERRYIN_API_KEY,
|
||||
// optional overrides:
|
||||
// baseURL: 'https://open.cherryin.net/v1',
|
||||
// anthropicBaseURL: 'https://open.cherryin.net/anthropic',
|
||||
// geminiBaseURL: 'https://open.cherryin.net/gemini/v1beta',
|
||||
})
|
||||
|
||||
// Chat models will auto-route based on the model id prefix:
|
||||
const openaiModel = cherryInProvider.chat('gpt-4o-mini')
|
||||
const anthropicModel = cherryInProvider.chat('claude-3-5-sonnet-latest')
|
||||
const geminiModel = cherryInProvider.chat('gemini-2.0-pro-exp')
|
||||
|
||||
const { text } = await openaiModel.invoke('Hello CherryIN!')
|
||||
```
|
||||
|
||||
The provider also exposes `completion`, `responses`, `embedding`, `image`, `transcription`, and `speech` helpers aligned with the upstream APIs.
|
||||
|
||||
See [AI SDK docs](https://ai-sdk.dev/providers/community-providers/custom-providers) for configuring custom providers.
|
||||
64
packages/ai-sdk-provider/package.json
Normal file
64
packages/ai-sdk-provider/package.json
Normal file
@@ -0,0 +1,64 @@
|
||||
{
|
||||
"name": "@cherrystudio/ai-sdk-provider",
|
||||
"version": "0.1.3",
|
||||
"description": "Cherry Studio AI SDK provider bundle with CherryIN routing.",
|
||||
"keywords": [
|
||||
"ai-sdk",
|
||||
"provider",
|
||||
"cherryin",
|
||||
"vercel-ai-sdk",
|
||||
"cherry-studio"
|
||||
],
|
||||
"author": "Cherry Studio",
|
||||
"license": "MIT",
|
||||
"homepage": "https://github.com/CherryHQ/cherry-studio",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://github.com/CherryHQ/cherry-studio.git",
|
||||
"directory": "packages/ai-sdk-provider"
|
||||
},
|
||||
"bugs": {
|
||||
"url": "https://github.com/CherryHQ/cherry-studio/issues"
|
||||
},
|
||||
"type": "module",
|
||||
"main": "dist/index.cjs",
|
||||
"module": "dist/index.js",
|
||||
"types": "dist/index.d.ts",
|
||||
"files": [
|
||||
"dist"
|
||||
],
|
||||
"scripts": {
|
||||
"build": "tsdown",
|
||||
"dev": "tsc -w",
|
||||
"clean": "rm -rf dist",
|
||||
"test": "vitest run",
|
||||
"test:watch": "vitest"
|
||||
},
|
||||
"peerDependencies": {
|
||||
"@ai-sdk/anthropic": "^2.0.29",
|
||||
"@ai-sdk/google": "^2.0.23",
|
||||
"@ai-sdk/openai": "^2.0.64",
|
||||
"ai": "^5.0.26"
|
||||
},
|
||||
"dependencies": {
|
||||
"@ai-sdk/provider": "^2.0.0",
|
||||
"@ai-sdk/provider-utils": "^3.0.12"
|
||||
},
|
||||
"devDependencies": {
|
||||
"tsdown": "^0.13.3",
|
||||
"typescript": "^5.8.2",
|
||||
"vitest": "^3.2.4"
|
||||
},
|
||||
"sideEffects": false,
|
||||
"engines": {
|
||||
"node": ">=18.0.0"
|
||||
},
|
||||
"exports": {
|
||||
".": {
|
||||
"types": "./dist/index.d.ts",
|
||||
"import": "./dist/index.js",
|
||||
"require": "./dist/index.cjs",
|
||||
"default": "./dist/index.js"
|
||||
}
|
||||
}
|
||||
}
|
||||
347
packages/ai-sdk-provider/src/cherryin-provider.ts
Normal file
347
packages/ai-sdk-provider/src/cherryin-provider.ts
Normal file
@@ -0,0 +1,347 @@
|
||||
import { AnthropicMessagesLanguageModel } from '@ai-sdk/anthropic/internal'
|
||||
import { GoogleGenerativeAILanguageModel } from '@ai-sdk/google/internal'
|
||||
import type { OpenAIProviderSettings } from '@ai-sdk/openai'
|
||||
import {
|
||||
OpenAIChatLanguageModel,
|
||||
OpenAICompletionLanguageModel,
|
||||
OpenAIEmbeddingModel,
|
||||
OpenAIImageModel,
|
||||
OpenAIResponsesLanguageModel,
|
||||
OpenAISpeechModel,
|
||||
OpenAITranscriptionModel
|
||||
} from '@ai-sdk/openai/internal'
|
||||
import {
|
||||
type EmbeddingModelV2,
|
||||
type ImageModelV2,
|
||||
type LanguageModelV2,
|
||||
type ProviderV2,
|
||||
type SpeechModelV2,
|
||||
type TranscriptionModelV2
|
||||
} from '@ai-sdk/provider'
|
||||
import type { FetchFunction } from '@ai-sdk/provider-utils'
|
||||
import { loadApiKey, withoutTrailingSlash } from '@ai-sdk/provider-utils'
|
||||
|
||||
export const CHERRYIN_PROVIDER_NAME = 'cherryin' as const
|
||||
export const DEFAULT_CHERRYIN_BASE_URL = 'https://open.cherryin.net/v1'
|
||||
export const DEFAULT_CHERRYIN_ANTHROPIC_BASE_URL = 'https://open.cherryin.net/v1'
|
||||
export const DEFAULT_CHERRYIN_GEMINI_BASE_URL = 'https://open.cherryin.net/v1beta/models'
|
||||
|
||||
const ANTHROPIC_PREFIX = /^anthropic\//i
|
||||
const GEMINI_PREFIX = /^google\//i
|
||||
// const GEMINI_EXCLUDED_SUFFIXES = ['-nothink', '-search']
|
||||
|
||||
type HeaderValue = string | undefined
|
||||
|
||||
type HeadersInput = Record<string, HeaderValue> | (() => Record<string, HeaderValue>)
|
||||
|
||||
export interface CherryInProviderSettings {
|
||||
/**
|
||||
* CherryIN API key.
|
||||
*
|
||||
* If omitted, the provider will read the `CHERRYIN_API_KEY` environment variable.
|
||||
*/
|
||||
apiKey?: string
|
||||
/**
|
||||
* Optional custom fetch implementation.
|
||||
*/
|
||||
fetch?: FetchFunction
|
||||
/**
|
||||
* Base URL for OpenAI-compatible CherryIN endpoints.
|
||||
*
|
||||
* Defaults to `https://open.cherryin.net/v1`.
|
||||
*/
|
||||
baseURL?: string
|
||||
/**
|
||||
* Base URL for Anthropic-compatible endpoints.
|
||||
*
|
||||
* Defaults to `https://open.cherryin.net/anthropic`.
|
||||
*/
|
||||
anthropicBaseURL?: string
|
||||
/**
|
||||
* Base URL for Gemini-compatible endpoints.
|
||||
*
|
||||
* Defaults to `https://open.cherryin.net/gemini/v1beta`.
|
||||
*/
|
||||
geminiBaseURL?: string
|
||||
/**
|
||||
* Optional static headers applied to every request.
|
||||
*/
|
||||
headers?: HeadersInput
|
||||
/**
|
||||
* Optional endpoint type to distinguish different endpoint behaviors.
|
||||
*/
|
||||
endpointType?: 'openai' | 'openai-response' | 'anthropic' | 'gemini' | 'image-generation' | 'jina-rerank'
|
||||
}
|
||||
|
||||
export interface CherryInProvider extends ProviderV2 {
|
||||
(modelId: string, settings?: OpenAIProviderSettings): LanguageModelV2
|
||||
languageModel(modelId: string, settings?: OpenAIProviderSettings): LanguageModelV2
|
||||
chat(modelId: string, settings?: OpenAIProviderSettings): LanguageModelV2
|
||||
responses(modelId: string): LanguageModelV2
|
||||
completion(modelId: string, settings?: OpenAIProviderSettings): LanguageModelV2
|
||||
embedding(modelId: string, settings?: OpenAIProviderSettings): EmbeddingModelV2<string>
|
||||
textEmbedding(modelId: string, settings?: OpenAIProviderSettings): EmbeddingModelV2<string>
|
||||
textEmbeddingModel(modelId: string, settings?: OpenAIProviderSettings): EmbeddingModelV2<string>
|
||||
image(modelId: string, settings?: OpenAIProviderSettings): ImageModelV2
|
||||
imageModel(modelId: string, settings?: OpenAIProviderSettings): ImageModelV2
|
||||
transcription(modelId: string): TranscriptionModelV2
|
||||
transcriptionModel(modelId: string): TranscriptionModelV2
|
||||
speech(modelId: string): SpeechModelV2
|
||||
speechModel(modelId: string): SpeechModelV2
|
||||
}
|
||||
|
||||
const resolveApiKey = (options: CherryInProviderSettings): string =>
|
||||
loadApiKey({
|
||||
apiKey: options.apiKey,
|
||||
environmentVariableName: 'CHERRYIN_API_KEY',
|
||||
description: 'CherryIN'
|
||||
})
|
||||
|
||||
const isAnthropicModel = (modelId: string) => ANTHROPIC_PREFIX.test(modelId)
|
||||
const isGeminiModel = (modelId: string) => GEMINI_PREFIX.test(modelId)
|
||||
|
||||
const createCustomFetch = (originalFetch?: any) => {
|
||||
return async (url: string, options: any) => {
|
||||
if (options?.body) {
|
||||
try {
|
||||
const body = JSON.parse(options.body)
|
||||
if (body.tools && Array.isArray(body.tools) && body.tools.length === 0 && body.tool_choice) {
|
||||
delete body.tool_choice
|
||||
options.body = JSON.stringify(body)
|
||||
}
|
||||
} catch (error) {
|
||||
// ignore error
|
||||
}
|
||||
}
|
||||
|
||||
return originalFetch ? originalFetch(url, options) : fetch(url, options)
|
||||
}
|
||||
}
|
||||
class CherryInOpenAIChatLanguageModel extends OpenAIChatLanguageModel {
|
||||
constructor(modelId: string, settings: any) {
|
||||
super(modelId, {
|
||||
...settings,
|
||||
fetch: createCustomFetch(settings.fetch)
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
const resolveConfiguredHeaders = (headers?: HeadersInput): Record<string, HeaderValue> => {
|
||||
if (typeof headers === 'function') {
|
||||
return { ...headers() }
|
||||
}
|
||||
return headers ? { ...headers } : {}
|
||||
}
|
||||
|
||||
const toBearerToken = (authorization?: string) => (authorization ? authorization.replace(/^Bearer\s+/i, '') : undefined)
|
||||
|
||||
const createJsonHeadersGetter = (options: CherryInProviderSettings): (() => Record<string, HeaderValue>) => {
|
||||
return () => ({
|
||||
Authorization: `Bearer ${resolveApiKey(options)}`,
|
||||
'Content-Type': 'application/json',
|
||||
...resolveConfiguredHeaders(options.headers)
|
||||
})
|
||||
}
|
||||
|
||||
const createAuthHeadersGetter = (options: CherryInProviderSettings): (() => Record<string, HeaderValue>) => {
|
||||
return () => ({
|
||||
Authorization: `Bearer ${resolveApiKey(options)}`,
|
||||
...resolveConfiguredHeaders(options.headers)
|
||||
})
|
||||
}
|
||||
|
||||
export const createCherryIn = (options: CherryInProviderSettings = {}): CherryInProvider => {
|
||||
const {
|
||||
baseURL = DEFAULT_CHERRYIN_BASE_URL,
|
||||
anthropicBaseURL = DEFAULT_CHERRYIN_ANTHROPIC_BASE_URL,
|
||||
geminiBaseURL = DEFAULT_CHERRYIN_GEMINI_BASE_URL,
|
||||
fetch,
|
||||
endpointType
|
||||
} = options
|
||||
|
||||
const getJsonHeaders = createJsonHeadersGetter(options)
|
||||
const getAuthHeaders = createAuthHeadersGetter(options)
|
||||
|
||||
const url = ({ path }: { path: string; modelId: string }) => `${withoutTrailingSlash(baseURL)}${path}`
|
||||
|
||||
const createAnthropicModel = (modelId: string) =>
|
||||
new AnthropicMessagesLanguageModel(modelId, {
|
||||
provider: `${CHERRYIN_PROVIDER_NAME}.anthropic`,
|
||||
baseURL: anthropicBaseURL,
|
||||
headers: () => {
|
||||
const headers = getJsonHeaders()
|
||||
const apiKey = toBearerToken(headers.Authorization)
|
||||
return {
|
||||
...headers,
|
||||
'x-api-key': apiKey
|
||||
}
|
||||
},
|
||||
fetch,
|
||||
supportedUrls: () => ({
|
||||
'image/*': [/^https?:\/\/.*$/]
|
||||
})
|
||||
})
|
||||
|
||||
const createGeminiModel = (modelId: string) =>
|
||||
new GoogleGenerativeAILanguageModel(modelId, {
|
||||
provider: `${CHERRYIN_PROVIDER_NAME}.google`,
|
||||
baseURL: geminiBaseURL,
|
||||
headers: () => {
|
||||
const headers = getJsonHeaders()
|
||||
const apiKey = toBearerToken(headers.Authorization)
|
||||
return {
|
||||
...headers,
|
||||
'x-goog-api-key': apiKey
|
||||
}
|
||||
},
|
||||
fetch,
|
||||
generateId: () => `${CHERRYIN_PROVIDER_NAME}-${Date.now()}`,
|
||||
supportedUrls: () => ({})
|
||||
})
|
||||
|
||||
const createOpenAIChatModel = (modelId: string, settings: OpenAIProviderSettings = {}) =>
|
||||
new CherryInOpenAIChatLanguageModel(modelId, {
|
||||
provider: `${CHERRYIN_PROVIDER_NAME}.openai-chat`,
|
||||
url,
|
||||
headers: () => ({
|
||||
...getJsonHeaders(),
|
||||
...settings.headers
|
||||
}),
|
||||
fetch
|
||||
})
|
||||
|
||||
const createChatModelByModelId = (modelId: string, settings: OpenAIProviderSettings = {}) => {
|
||||
if (isAnthropicModel(modelId)) {
|
||||
return createAnthropicModel(modelId)
|
||||
}
|
||||
if (isGeminiModel(modelId)) {
|
||||
return createGeminiModel(modelId)
|
||||
}
|
||||
return new OpenAIResponsesLanguageModel(modelId, {
|
||||
provider: `${CHERRYIN_PROVIDER_NAME}.openai`,
|
||||
url,
|
||||
headers: () => ({
|
||||
...getJsonHeaders(),
|
||||
...settings.headers
|
||||
}),
|
||||
fetch
|
||||
})
|
||||
}
|
||||
|
||||
const createChatModel = (modelId: string, settings: OpenAIProviderSettings = {}) => {
|
||||
if (!endpointType) return createChatModelByModelId(modelId, settings)
|
||||
switch (endpointType) {
|
||||
case 'anthropic':
|
||||
return createAnthropicModel(modelId)
|
||||
case 'gemini':
|
||||
return createGeminiModel(modelId)
|
||||
case 'openai':
|
||||
return createOpenAIChatModel(modelId)
|
||||
case 'openai-response':
|
||||
default:
|
||||
return new OpenAIResponsesLanguageModel(modelId, {
|
||||
provider: `${CHERRYIN_PROVIDER_NAME}.openai`,
|
||||
url,
|
||||
headers: () => ({
|
||||
...getJsonHeaders(),
|
||||
...settings.headers
|
||||
}),
|
||||
fetch
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
const createCompletionModel = (modelId: string, settings: OpenAIProviderSettings = {}) =>
|
||||
new OpenAICompletionLanguageModel(modelId, {
|
||||
provider: `${CHERRYIN_PROVIDER_NAME}.completion`,
|
||||
url,
|
||||
headers: () => ({
|
||||
...getJsonHeaders(),
|
||||
...settings.headers
|
||||
}),
|
||||
fetch
|
||||
})
|
||||
|
||||
const createEmbeddingModel = (modelId: string, settings: OpenAIProviderSettings = {}) =>
|
||||
new OpenAIEmbeddingModel(modelId, {
|
||||
provider: `${CHERRYIN_PROVIDER_NAME}.embeddings`,
|
||||
url,
|
||||
headers: () => ({
|
||||
...getJsonHeaders(),
|
||||
...settings.headers
|
||||
}),
|
||||
fetch
|
||||
})
|
||||
|
||||
const createResponsesModel = (modelId: string) =>
|
||||
new OpenAIResponsesLanguageModel(modelId, {
|
||||
provider: `${CHERRYIN_PROVIDER_NAME}.responses`,
|
||||
url,
|
||||
headers: () => ({
|
||||
...getJsonHeaders()
|
||||
}),
|
||||
fetch
|
||||
})
|
||||
|
||||
const createImageModel = (modelId: string, settings: OpenAIProviderSettings = {}) =>
|
||||
new OpenAIImageModel(modelId, {
|
||||
provider: `${CHERRYIN_PROVIDER_NAME}.image`,
|
||||
url,
|
||||
headers: () => ({
|
||||
...getJsonHeaders(),
|
||||
...settings.headers
|
||||
}),
|
||||
fetch
|
||||
})
|
||||
|
||||
const createTranscriptionModel = (modelId: string) =>
|
||||
new OpenAITranscriptionModel(modelId, {
|
||||
provider: `${CHERRYIN_PROVIDER_NAME}.transcription`,
|
||||
url,
|
||||
headers: () => ({
|
||||
...getAuthHeaders()
|
||||
}),
|
||||
fetch
|
||||
})
|
||||
|
||||
const createSpeechModel = (modelId: string) =>
|
||||
new OpenAISpeechModel(modelId, {
|
||||
provider: `${CHERRYIN_PROVIDER_NAME}.speech`,
|
||||
url,
|
||||
headers: () => ({
|
||||
...getJsonHeaders()
|
||||
}),
|
||||
fetch
|
||||
})
|
||||
|
||||
const provider: CherryInProvider = function (modelId: string, settings?: OpenAIProviderSettings) {
|
||||
if (new.target) {
|
||||
throw new Error('CherryIN provider function cannot be called with the new keyword.')
|
||||
}
|
||||
|
||||
return createChatModel(modelId, settings)
|
||||
}
|
||||
|
||||
provider.languageModel = createChatModel
|
||||
provider.chat = createOpenAIChatModel
|
||||
|
||||
provider.responses = createResponsesModel
|
||||
provider.completion = createCompletionModel
|
||||
|
||||
provider.embedding = createEmbeddingModel
|
||||
provider.textEmbedding = createEmbeddingModel
|
||||
provider.textEmbeddingModel = createEmbeddingModel
|
||||
|
||||
provider.image = createImageModel
|
||||
provider.imageModel = createImageModel
|
||||
|
||||
provider.transcription = createTranscriptionModel
|
||||
provider.transcriptionModel = createTranscriptionModel
|
||||
|
||||
provider.speech = createSpeechModel
|
||||
provider.speechModel = createSpeechModel
|
||||
|
||||
return provider
|
||||
}
|
||||
|
||||
export const cherryIn = createCherryIn()
|
||||
1
packages/ai-sdk-provider/src/index.ts
Normal file
1
packages/ai-sdk-provider/src/index.ts
Normal file
@@ -0,0 +1 @@
|
||||
export * from './cherryin-provider'
|
||||
19
packages/ai-sdk-provider/tsconfig.json
Normal file
19
packages/ai-sdk-provider/tsconfig.json
Normal file
@@ -0,0 +1,19 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"allowSyntheticDefaultImports": true,
|
||||
"declaration": true,
|
||||
"esModuleInterop": true,
|
||||
"forceConsistentCasingInFileNames": true,
|
||||
"module": "ESNext",
|
||||
"moduleResolution": "bundler",
|
||||
"noEmitOnError": false,
|
||||
"outDir": "./dist",
|
||||
"resolveJsonModule": true,
|
||||
"rootDir": "./src",
|
||||
"skipLibCheck": true,
|
||||
"strict": true,
|
||||
"target": "ES2020"
|
||||
},
|
||||
"exclude": ["node_modules", "dist"],
|
||||
"include": ["src/**/*"]
|
||||
}
|
||||
12
packages/ai-sdk-provider/tsdown.config.ts
Normal file
12
packages/ai-sdk-provider/tsdown.config.ts
Normal file
@@ -0,0 +1,12 @@
|
||||
import { defineConfig } from 'tsdown'
|
||||
|
||||
export default defineConfig({
|
||||
entry: {
|
||||
index: 'src/index.ts'
|
||||
},
|
||||
outDir: 'dist',
|
||||
format: ['esm', 'cjs'],
|
||||
clean: true,
|
||||
dts: true,
|
||||
tsconfig: 'tsconfig.json'
|
||||
})
|
||||
@@ -71,7 +71,7 @@ Cherry Studio AI Core 是一个基于 Vercel AI SDK 的统一 AI Provider 接口
|
||||
## 安装
|
||||
|
||||
```bash
|
||||
npm install @cherrystudio/ai-core ai
|
||||
npm install @cherrystudio/ai-core ai @ai-sdk/google @ai-sdk/openai
|
||||
```
|
||||
|
||||
### React Native
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"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",
|
||||
"main": "dist/index.js",
|
||||
"module": "dist/index.mjs",
|
||||
@@ -33,17 +33,19 @@
|
||||
},
|
||||
"homepage": "https://github.com/CherryHQ/cherry-studio#readme",
|
||||
"peerDependencies": {
|
||||
"@ai-sdk/google": "^2.0.36",
|
||||
"@ai-sdk/openai": "^2.0.64",
|
||||
"@cherrystudio/ai-sdk-provider": "^0.1.3",
|
||||
"ai": "^5.0.26"
|
||||
},
|
||||
"dependencies": {
|
||||
"@ai-sdk/anthropic": "^2.0.32",
|
||||
"@ai-sdk/azure": "^2.0.53",
|
||||
"@ai-sdk/deepseek": "^1.0.23",
|
||||
"@ai-sdk/openai": "patch:@ai-sdk/openai@npm%3A2.0.52#~/.yarn/patches/@ai-sdk-openai-npm-2.0.52-b36d949c76.patch",
|
||||
"@ai-sdk/openai-compatible": "^1.0.22",
|
||||
"@ai-sdk/anthropic": "^2.0.43",
|
||||
"@ai-sdk/azure": "^2.0.66",
|
||||
"@ai-sdk/deepseek": "^1.0.27",
|
||||
"@ai-sdk/openai-compatible": "^1.0.26",
|
||||
"@ai-sdk/provider": "^2.0.0",
|
||||
"@ai-sdk/provider-utils": "^3.0.12",
|
||||
"@ai-sdk/xai": "^2.0.26",
|
||||
"@ai-sdk/provider-utils": "^3.0.16",
|
||||
"@ai-sdk/xai": "^2.0.31",
|
||||
"zod": "^4.1.5"
|
||||
},
|
||||
"devDependencies": {
|
||||
|
||||
@@ -4,12 +4,7 @@
|
||||
*/
|
||||
export const BUILT_IN_PLUGIN_PREFIX = 'built-in:'
|
||||
|
||||
export { googleToolsPlugin } from './googleToolsPlugin'
|
||||
export { createLoggingPlugin } from './logging'
|
||||
export { createPromptToolUsePlugin } from './toolUsePlugin/promptToolUsePlugin'
|
||||
export type {
|
||||
PromptToolUseConfig,
|
||||
ToolUseRequestContext,
|
||||
ToolUseResult
|
||||
} from './toolUsePlugin/type'
|
||||
export { webSearchPlugin, type WebSearchPluginConfig } from './webSearchPlugin'
|
||||
export * from './googleToolsPlugin'
|
||||
export * from './toolUsePlugin/promptToolUsePlugin'
|
||||
export * from './toolUsePlugin/type'
|
||||
export * from './webSearchPlugin'
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
import type { anthropic } from '@ai-sdk/anthropic'
|
||||
import type { google } from '@ai-sdk/google'
|
||||
import type { openai } from '@ai-sdk/openai'
|
||||
import type { InferToolInput, InferToolOutput } from 'ai'
|
||||
import { type Tool } from 'ai'
|
||||
import { anthropic } from '@ai-sdk/anthropic'
|
||||
import { google } from '@ai-sdk/google'
|
||||
import { openai } from '@ai-sdk/openai'
|
||||
import type { InferToolInput, InferToolOutput, Tool } from 'ai'
|
||||
|
||||
import { createOpenRouterOptions, createXaiOptions, mergeProviderOptions } from '../../../options'
|
||||
import type { ProviderOptionsMap } from '../../../options/types'
|
||||
import type { OpenRouterSearchConfig } from './openrouter'
|
||||
|
||||
@@ -95,3 +95,56 @@ export type WebSearchToolInputSchema = {
|
||||
google: InferToolInput<GoogleWebSearchTool>
|
||||
'openai-chat': InferToolInput<OpenAIChatWebSearchTool>
|
||||
}
|
||||
|
||||
export const switchWebSearchTool = (providerId: string, config: WebSearchPluginConfig, params: any) => {
|
||||
switch (providerId) {
|
||||
case 'openai': {
|
||||
if (config.openai) {
|
||||
if (!params.tools) params.tools = {}
|
||||
params.tools.web_search = openai.tools.webSearch(config.openai)
|
||||
}
|
||||
break
|
||||
}
|
||||
case 'openai-chat': {
|
||||
if (config['openai-chat']) {
|
||||
if (!params.tools) params.tools = {}
|
||||
params.tools.web_search_preview = openai.tools.webSearchPreview(config['openai-chat'])
|
||||
}
|
||||
break
|
||||
}
|
||||
|
||||
case 'anthropic': {
|
||||
if (config.anthropic) {
|
||||
if (!params.tools) params.tools = {}
|
||||
params.tools.web_search = anthropic.tools.webSearch_20250305(config.anthropic)
|
||||
}
|
||||
break
|
||||
}
|
||||
|
||||
case 'google': {
|
||||
// case 'google-vertex':
|
||||
if (!params.tools) params.tools = {}
|
||||
params.tools.web_search = google.tools.googleSearch(config.google || {})
|
||||
break
|
||||
}
|
||||
|
||||
case 'xai': {
|
||||
if (config.xai) {
|
||||
const searchOptions = createXaiOptions({
|
||||
searchParameters: { ...config.xai, mode: 'on' }
|
||||
})
|
||||
params.providerOptions = mergeProviderOptions(params.providerOptions, searchOptions)
|
||||
}
|
||||
break
|
||||
}
|
||||
|
||||
case 'openrouter': {
|
||||
if (config.openrouter) {
|
||||
const searchOptions = createOpenRouterOptions(config.openrouter)
|
||||
params.providerOptions = mergeProviderOptions(params.providerOptions, searchOptions)
|
||||
}
|
||||
break
|
||||
}
|
||||
}
|
||||
return params
|
||||
}
|
||||
|
||||
@@ -2,15 +2,11 @@
|
||||
* Web Search Plugin
|
||||
* 提供统一的网络搜索能力,支持多个 AI Provider
|
||||
*/
|
||||
import { anthropic } from '@ai-sdk/anthropic'
|
||||
import { google } from '@ai-sdk/google'
|
||||
import { openai } from '@ai-sdk/openai'
|
||||
|
||||
import { createOpenRouterOptions, createXaiOptions, mergeProviderOptions } from '../../../options'
|
||||
import { definePlugin } from '../../'
|
||||
import type { AiRequestContext } from '../../types'
|
||||
import type { WebSearchPluginConfig } from './helper'
|
||||
import { DEFAULT_WEB_SEARCH_CONFIG } from './helper'
|
||||
import { DEFAULT_WEB_SEARCH_CONFIG, switchWebSearchTool } from './helper'
|
||||
|
||||
/**
|
||||
* 网络搜索插件
|
||||
@@ -24,62 +20,19 @@ export const webSearchPlugin = (config: WebSearchPluginConfig = DEFAULT_WEB_SEAR
|
||||
|
||||
transformParams: async (params: any, context: AiRequestContext) => {
|
||||
const { providerId } = context
|
||||
switch (providerId) {
|
||||
case 'openai': {
|
||||
if (config.openai) {
|
||||
if (!params.tools) params.tools = {}
|
||||
params.tools.web_search = openai.tools.webSearch(config.openai)
|
||||
}
|
||||
break
|
||||
}
|
||||
case 'openai-chat': {
|
||||
if (config['openai-chat']) {
|
||||
if (!params.tools) params.tools = {}
|
||||
params.tools.web_search_preview = openai.tools.webSearchPreview(config['openai-chat'])
|
||||
}
|
||||
break
|
||||
}
|
||||
switchWebSearchTool(providerId, config, params)
|
||||
|
||||
case 'anthropic': {
|
||||
if (config.anthropic) {
|
||||
if (!params.tools) params.tools = {}
|
||||
params.tools.web_search = anthropic.tools.webSearch_20250305(config.anthropic)
|
||||
}
|
||||
break
|
||||
}
|
||||
|
||||
case 'google': {
|
||||
// case 'google-vertex':
|
||||
if (!params.tools) params.tools = {}
|
||||
params.tools.web_search = google.tools.googleSearch(config.google || {})
|
||||
break
|
||||
}
|
||||
|
||||
case 'xai': {
|
||||
if (config.xai) {
|
||||
const searchOptions = createXaiOptions({
|
||||
searchParameters: { ...config.xai, mode: 'on' }
|
||||
})
|
||||
params.providerOptions = mergeProviderOptions(params.providerOptions, searchOptions)
|
||||
}
|
||||
break
|
||||
}
|
||||
|
||||
case 'openrouter': {
|
||||
if (config.openrouter) {
|
||||
const searchOptions = createOpenRouterOptions(config.openrouter)
|
||||
params.providerOptions = mergeProviderOptions(params.providerOptions, searchOptions)
|
||||
}
|
||||
break
|
||||
}
|
||||
if (providerId === 'cherryin' || providerId === 'cherryin-chat') {
|
||||
// cherryin.gemini
|
||||
const _providerId = params.model.provider.split('.')[1]
|
||||
switchWebSearchTool(_providerId, config, params)
|
||||
}
|
||||
|
||||
return params
|
||||
}
|
||||
})
|
||||
|
||||
// 导出类型定义供开发者使用
|
||||
export type { WebSearchPluginConfig, WebSearchToolOutputSchema } from './helper'
|
||||
export * from './helper'
|
||||
|
||||
// 默认导出
|
||||
export default webSearchPlugin
|
||||
|
||||
@@ -44,7 +44,7 @@ export {
|
||||
// ==================== 基础数据和类型 ====================
|
||||
|
||||
// 基础Provider数据源
|
||||
export { baseProviderIds, baseProviders } from './schemas'
|
||||
export { baseProviderIds, baseProviders, isBaseProvider } from './schemas'
|
||||
|
||||
// 类型定义和Schema
|
||||
export type {
|
||||
|
||||
@@ -7,11 +7,11 @@ import { createAzure } from '@ai-sdk/azure'
|
||||
import { type AzureOpenAIProviderSettings } from '@ai-sdk/azure'
|
||||
import { createDeepSeek } from '@ai-sdk/deepseek'
|
||||
import { createGoogleGenerativeAI } from '@ai-sdk/google'
|
||||
import { createHuggingFace } from '@ai-sdk/huggingface'
|
||||
import { createOpenAI, type OpenAIProviderSettings } from '@ai-sdk/openai'
|
||||
import { createOpenAICompatible } from '@ai-sdk/openai-compatible'
|
||||
import type { LanguageModelV2 } from '@ai-sdk/provider'
|
||||
import { createXai } from '@ai-sdk/xai'
|
||||
import { type CherryInProviderSettings, createCherryIn } from '@cherrystudio/ai-sdk-provider'
|
||||
import { createOpenRouter } from '@openrouter/ai-sdk-provider'
|
||||
import type { Provider } from 'ai'
|
||||
import { customProvider } from 'ai'
|
||||
@@ -31,7 +31,8 @@ export const baseProviderIds = [
|
||||
'azure-responses',
|
||||
'deepseek',
|
||||
'openrouter',
|
||||
'huggingface'
|
||||
'cherryin',
|
||||
'cherryin-chat'
|
||||
] as const
|
||||
|
||||
/**
|
||||
@@ -137,9 +138,23 @@ export const baseProviders = [
|
||||
supportsImageGeneration: true
|
||||
},
|
||||
{
|
||||
id: 'huggingface',
|
||||
name: 'HuggingFace',
|
||||
creator: createHuggingFace,
|
||||
id: 'cherryin',
|
||||
name: 'CherryIN',
|
||||
creator: createCherryIn,
|
||||
supportsImageGeneration: true
|
||||
},
|
||||
{
|
||||
id: 'cherryin-chat',
|
||||
name: 'CherryIN Chat',
|
||||
creator: (options: CherryInProviderSettings) => {
|
||||
const provider = createCherryIn(options)
|
||||
return customProvider({
|
||||
fallbackProvider: {
|
||||
...provider,
|
||||
languageModel: (modelId: string) => provider.chat(modelId)
|
||||
}
|
||||
})
|
||||
},
|
||||
supportsImageGeneration: true
|
||||
}
|
||||
] as const satisfies BaseProvider[]
|
||||
|
||||
857
packages/catalog/PLANS.md
Normal file
857
packages/catalog/PLANS.md
Normal file
@@ -0,0 +1,857 @@
|
||||
# 模型和供应商参数化配置实现方案
|
||||
|
||||
## 📋 项目概述
|
||||
|
||||
本文档描述了在 `@packages/catalog/` 下实现模型和供应商参数化配置的方案,目标是将现有的硬编码逻辑重构为元数据驱动的配置系统。
|
||||
|
||||
## 🎯 目标
|
||||
|
||||
### 主要目标
|
||||
- 将硬编码的模型识别逻辑转换为 JSON 配置驱动
|
||||
- 解决"同一模型在不同供应商下有差异"的问题
|
||||
- 提供类型安全的配置系统(使用 Zod)
|
||||
- 支持未来通过配置更新添加新模型
|
||||
|
||||
### 痛点解决
|
||||
- **当前问题**:`src/renderer/src/config/models/` 下复杂的正则表达式和硬编码逻辑
|
||||
- **期望状态**:配置以 JSON 形式存在,代码中使用 Zod Schema 验证
|
||||
- **可维护性**:新模型发布时只需更新 JSON 配置,无需修改代码
|
||||
|
||||
## 🏗️ 架构设计
|
||||
|
||||
### 三层分离的元数据架构
|
||||
|
||||
```
|
||||
1. Base Model Catalog (models/*.json)
|
||||
├─ 模型基础信息(ID、能力、模态、限制、价格)
|
||||
└─ 官方/标准配置
|
||||
|
||||
2. Provider Catalog (providers/*.json)
|
||||
├─ 供应商特性(端点支持、API 兼容性)
|
||||
└─ 认证和定价模型
|
||||
|
||||
3. Provider Model Overrides (overrides/*.json)
|
||||
├─ 供应商对特定模型的覆盖
|
||||
└─ 解决"同一模型不同供应商差异"问题
|
||||
```
|
||||
|
||||
### 简化后的文件结构
|
||||
|
||||
```
|
||||
packages/catalog/
|
||||
├── src/
|
||||
│ ├── index.ts # 主导出文件
|
||||
│ ├── schemas/ # Schema 定义
|
||||
│ │ ├── index.ts # 统一导出
|
||||
│ │ ├── model.schema.ts # 模型配置 Schema + Zod
|
||||
│ │ ├── provider.schema.ts # 供应商配置 Schema + Zod
|
||||
│ │ └── override.schema.ts # 覆盖配置 Schema + Zod
|
||||
│ ├── data/ # 配置数据(单文件存储)
|
||||
│ │ ├── models.json # 所有模型配置
|
||||
│ │ ├── providers.json # 所有供应商配置
|
||||
│ │ └── overrides.json # 所有覆盖配置
|
||||
│ ├── services/ # 核心服务
|
||||
│ │ ├── CatalogService.ts # 统一的目录服务
|
||||
│ │ └── ConfigLoader.ts # 配置加载 + 验证
|
||||
│ ├── utils/ # 工具函数
|
||||
│ │ ├── migrate.ts # 迁移工具(从旧代码提取配置)
|
||||
│ │ └── helpers.ts # 辅助函数
|
||||
│ └── __tests__/ # 测试文件
|
||||
│ ├── fixtures/ # 测试数据
|
||||
│ ├── schemas.test.ts # Schema 测试
|
||||
│ └── catalog.test.ts # 目录服务测试
|
||||
├── scripts/
|
||||
│ └── migrate.ts # 迁移脚本 CLI
|
||||
└── package.json
|
||||
```
|
||||
|
||||
## 📝 Schema 定义
|
||||
|
||||
### 1. 模型配置 Schema
|
||||
|
||||
```typescript
|
||||
// packages/catalog/src/schemas/model.schema.ts
|
||||
|
||||
import * as z from 'zod'
|
||||
import { EndpointTypeSchema } from './provider.schema'
|
||||
|
||||
// 模态类型
|
||||
export const ModalitySchema = z.enum(['TEXT', 'VISION', 'AUDIO', 'VIDEO', 'VECTOR'])
|
||||
|
||||
// 能力类型
|
||||
export const ModelCapabilityTypeSchema = z.enum([
|
||||
'FUNCTION_CALL', // 函数调用
|
||||
'REASONING', // 推理
|
||||
'IMAGE_RECOGNITION', // 图像识别
|
||||
'IMAGE_GENERATION', // 图像生成
|
||||
'AUDIO_RECOGNITION', // 音频识别
|
||||
'AUDIO_GENERATION', // 音频生成
|
||||
'EMBEDDING', // 嵌入向量生成
|
||||
'RERANK', // 文本重排序
|
||||
'AUDIO_TRANSCRIPT', // 音频转录
|
||||
'VIDEO_RECOGNITION', // 视频识别
|
||||
'VIDEO_GENERATION', // 视频生成
|
||||
'STRUCTURED_OUTPUT', // 结构化输出
|
||||
'FILE_INPUT', // 文件输入支持
|
||||
'WEB_SEARCH', // 内置网络搜索
|
||||
'CODE_EXECUTION', // 代码执行
|
||||
'FILE_SEARCH', // 文件搜索
|
||||
'COMPUTER_USE' // 计算机使用
|
||||
])
|
||||
|
||||
// 推理配置
|
||||
export const ReasoningConfigSchema = z.object({
|
||||
supportedEfforts: z.array(z.enum(['low', 'medium', 'high'])),
|
||||
implementation: z.enum(['OPENAI_O1', 'ANTHROPIC_CLAUDE', 'DEEPSEEK_R1', 'GEMINI_THINKING']),
|
||||
reasoningMode: z.enum(['ALWAYS_ON', 'ON_DEMAND']),
|
||||
thinkingControl: z.object({
|
||||
enabled: z.boolean(),
|
||||
budget: z.object({
|
||||
min: z.number().optional(),
|
||||
max: z.number().optional()
|
||||
}).optional()
|
||||
}).optional()
|
||||
})
|
||||
|
||||
// 参数支持配置
|
||||
export const ParameterSupportSchema = z.object({
|
||||
temperature: z.object({
|
||||
supported: z.boolean(),
|
||||
min: z.number().min(0).max(2).optional(),
|
||||
max: z.number().min(0).max(2).optional(),
|
||||
default: z.number().min(0).max(2).optional()
|
||||
}).optional(),
|
||||
topP: z.object({
|
||||
supported: z.boolean(),
|
||||
min: z.number().min(0).max(1).optional(),
|
||||
max: z.number().min(0).max(1).optional(),
|
||||
default: z.number().min(0).max(1).optional()
|
||||
}).optional(),
|
||||
topK: z.object({
|
||||
supported: z.boolean(),
|
||||
min: z.number().positive().optional(),
|
||||
max: z.number().positive().optional()
|
||||
}).optional(),
|
||||
frequencyPenalty: z.boolean().optional(),
|
||||
presencePenalty: z.boolean().optional(),
|
||||
maxTokens: z.boolean().optional(),
|
||||
stopSequences: z.boolean().optional(),
|
||||
systemMessage: z.boolean().optional(),
|
||||
developerRole: z.boolean().optional()
|
||||
})
|
||||
|
||||
// 定价配置
|
||||
export const ModelPricingSchema = z.object({
|
||||
input: z.object({
|
||||
perMillionTokens: z.number(),
|
||||
currency: z.string().default('USD')
|
||||
}),
|
||||
output: z.object({
|
||||
perMillionTokens: z.number(),
|
||||
currency: z.string().default('USD')
|
||||
}),
|
||||
perImage: z.object({
|
||||
price: z.number(),
|
||||
currency: z.string().default('USD')
|
||||
}).optional(),
|
||||
perMinute: z.object({
|
||||
price: z.number(),
|
||||
currency: z.string().default('USD')
|
||||
}).optional()
|
||||
})
|
||||
|
||||
// 模型配置 Schema
|
||||
export const ModelConfigSchema = z.object({
|
||||
// 基础信息
|
||||
id: z.string(),
|
||||
name: z.string().optional(),
|
||||
ownedBy: z.string().optional(),
|
||||
description: z.string().optional(),
|
||||
|
||||
// 能力(核心)
|
||||
capabilities: z.array(ModelCapabilityTypeSchema),
|
||||
|
||||
// 模态
|
||||
inputModalities: z.array(ModalitySchema),
|
||||
outputModalities: z.array(ModalitySchema),
|
||||
|
||||
// 限制
|
||||
contextWindow: z.number(),
|
||||
maxOutputTokens: z.number(),
|
||||
maxInputTokens: z.number().optional(),
|
||||
|
||||
// 价格
|
||||
pricing: ModelPricingSchema.optional(),
|
||||
|
||||
// 推理配置
|
||||
reasoning: ReasoningConfigSchema.optional(),
|
||||
|
||||
// 参数支持
|
||||
parameters: ParameterSupportSchema.optional(),
|
||||
|
||||
// 端点类型
|
||||
endpointTypes: z.array(EndpointTypeSchema).optional(),
|
||||
|
||||
// 元数据
|
||||
releaseDate: z.string().optional(),
|
||||
deprecationDate: z.string().optional(),
|
||||
replacedBy: z.string().optional()
|
||||
})
|
||||
|
||||
export type ModelConfig = z.infer<typeof ModelConfigSchema>
|
||||
```
|
||||
|
||||
### 2. 供应商配置 Schema(简化版)
|
||||
|
||||
```typescript
|
||||
// packages/catalog/src/schemas/provider.schema.ts
|
||||
|
||||
import * as z from 'zod'
|
||||
|
||||
// 端点类型
|
||||
export const EndpointTypeSchema = z.enum([
|
||||
'CHAT_COMPLETIONS',
|
||||
'COMPLETIONS',
|
||||
'EMBEDDINGS',
|
||||
'IMAGE_GENERATION',
|
||||
'AUDIO_SPEECH',
|
||||
'AUDIO_TRANSCRIPTIONS',
|
||||
'MESSAGES',
|
||||
'GENERATE_CONTENT',
|
||||
'RERANK',
|
||||
'MODERATIONS'
|
||||
])
|
||||
|
||||
// 认证方式
|
||||
export const AuthenticationSchema = z.enum([
|
||||
'API_KEY',
|
||||
'OAUTH',
|
||||
'CLOUD_CREDENTIALS'
|
||||
])
|
||||
|
||||
// 定价模型
|
||||
export const PricingModelSchema = z.enum([
|
||||
'UNIFIED', // 统一定价 (如 OpenRouter)
|
||||
'PER_MODEL', // 按模型独立定价 (如 OpenAI 官方)
|
||||
'TRANSPARENT', // 透明定价 (如 New-API)
|
||||
])
|
||||
|
||||
// 模型路由策略
|
||||
export const ModelRoutingSchema = z.enum([
|
||||
'INTELLIGENT', // 智能路由
|
||||
'DIRECT', // 直接路由
|
||||
'LOAD_BALANCED', // 负载均衡
|
||||
])
|
||||
|
||||
// API 兼容性配置
|
||||
export const ApiCompatibilitySchema = z.object({
|
||||
supportsArrayContent: z.boolean().default(true),
|
||||
supportsStreamOptions: z.boolean().default(true),
|
||||
supportsDeveloperRole: z.boolean().default(false),
|
||||
supportsThinkingControl: z.boolean().default(false),
|
||||
supportsParallelTools: z.boolean().default(false),
|
||||
supportsMultimodal: z.boolean().default(false),
|
||||
maxFileUploadSize: z.number().optional(),
|
||||
supportedFileTypes: z.array(z.string()).optional()
|
||||
})
|
||||
|
||||
// 供应商能力(简化版 - 使用数组代替多个布尔字段)
|
||||
export const ProviderCapabilitySchema = z.enum([
|
||||
'CUSTOM_MODELS', // 支持自定义模型
|
||||
'MODEL_MAPPING', // 提供模型映射
|
||||
'FALLBACK_ROUTING', // 降级路由
|
||||
'AUTO_RETRY', // 自动重试
|
||||
'REAL_TIME_METRICS', // 实时指标
|
||||
'USAGE_ANALYTICS', // 使用分析
|
||||
'STREAMING', // 流式响应
|
||||
'BATCH_PROCESSING', // 批量处理
|
||||
'RATE_LIMITING', // 速率限制
|
||||
])
|
||||
|
||||
// 供应商配置 Schema(简化版)
|
||||
export const ProviderConfigSchema = z.object({
|
||||
// 基础信息
|
||||
id: z.string(),
|
||||
name: z.string(),
|
||||
description: z.string().optional(),
|
||||
|
||||
// 核心配置
|
||||
authentication: AuthenticationSchema,
|
||||
pricingModel: PricingModelSchema,
|
||||
modelRouting: ModelRoutingSchema,
|
||||
|
||||
// 能力(使用数组替代多个布尔字段)
|
||||
capabilities: z.array(ProviderCapabilitySchema).default([]),
|
||||
|
||||
// 功能支持
|
||||
supportedEndpoints: z.array(EndpointTypeSchema),
|
||||
apiCompatibility: ApiCompatibilitySchema.optional(),
|
||||
|
||||
// 默认配置
|
||||
defaultApiHost: z.string().optional(),
|
||||
defaultRateLimit: z.number().optional(),
|
||||
|
||||
// 模型匹配
|
||||
modelIdPatterns: z.array(z.string()).optional(),
|
||||
aliasModelIds: z.record(z.string()).optional(),
|
||||
|
||||
// 元数据
|
||||
documentation: z.string().url().optional(),
|
||||
statusPage: z.string().url().optional(),
|
||||
|
||||
// 状态
|
||||
deprecated: z.boolean().default(false)
|
||||
})
|
||||
|
||||
export type ProviderConfig = z.infer<typeof ProviderConfigSchema>
|
||||
```
|
||||
|
||||
### 3. 覆盖配置 Schema
|
||||
|
||||
```typescript
|
||||
// packages/catalog/src/schemas/override.schema.ts
|
||||
|
||||
import * as z from 'zod'
|
||||
import { ModelCapabilityTypeSchema, ModelPricingSchema, ParameterSupportSchema } from './model.schema'
|
||||
|
||||
export const ProviderModelOverrideSchema = z.object({
|
||||
providerId: z.string(),
|
||||
modelId: z.string(),
|
||||
|
||||
// 能力覆盖
|
||||
capabilities: z.object({
|
||||
add: z.array(ModelCapabilityTypeSchema).optional(),
|
||||
remove: z.array(ModelCapabilityTypeSchema).optional()
|
||||
}).optional(),
|
||||
|
||||
// 限制覆盖
|
||||
limits: z.object({
|
||||
contextWindow: z.number().optional(),
|
||||
maxOutputTokens: z.number().optional()
|
||||
}).optional(),
|
||||
|
||||
// 价格覆盖
|
||||
pricing: ModelPricingSchema.optional(),
|
||||
|
||||
// 参数支持覆盖
|
||||
parameters: ParameterSupportSchema.optional(),
|
||||
|
||||
// 禁用模型
|
||||
disabled: z.boolean().optional(),
|
||||
|
||||
// 覆盖原因
|
||||
reason: z.string().optional()
|
||||
})
|
||||
|
||||
export type ProviderModelOverride = z.infer<typeof ProviderModelOverrideSchema>
|
||||
```
|
||||
|
||||
## 🔧 核心 API 设计
|
||||
|
||||
### 统一的目录服务
|
||||
|
||||
```typescript
|
||||
// packages/catalog/src/services/CatalogService.ts
|
||||
|
||||
export interface ModelFilters {
|
||||
capabilities?: ModelCapabilityType[]
|
||||
inputModalities?: Modality[]
|
||||
providers?: string[]
|
||||
minContextWindow?: number
|
||||
}
|
||||
|
||||
export interface ProviderFilter {
|
||||
capabilities?: ProviderCapability[]
|
||||
authentication?: AuthenticationSchema
|
||||
pricingModel?: PricingModelSchema
|
||||
notDeprecated?: boolean
|
||||
}
|
||||
|
||||
export class CatalogService {
|
||||
private models: Map<string, ModelConfig>
|
||||
private providers: Map<string, ProviderConfig>
|
||||
private overrides: Map<string, ProviderModelOverride[]>
|
||||
|
||||
// === 模型查询 ===
|
||||
|
||||
/**
|
||||
* 获取模型配置(应用供应商覆盖)
|
||||
*/
|
||||
getModel(modelId: string, providerId?: string): ModelConfig | null
|
||||
|
||||
/**
|
||||
* 检查模型能力
|
||||
*/
|
||||
hasCapability(modelId: string, capability: ModelCapabilityType, providerId?: string): boolean
|
||||
|
||||
/**
|
||||
* 获取模型的推理配置
|
||||
*/
|
||||
getReasoningConfig(modelId: string, providerId?: string): ReasoningConfig | null
|
||||
|
||||
/**
|
||||
* 获取模型参数范围
|
||||
*/
|
||||
getParameterRange(
|
||||
modelId: string,
|
||||
parameter: 'temperature' | 'topP' | 'topK',
|
||||
providerId?: string
|
||||
): { min: number, max: number, default?: number } | null
|
||||
|
||||
/**
|
||||
* 批量匹配模型
|
||||
*/
|
||||
findModels(filters?: ModelFilters): ModelConfig[]
|
||||
|
||||
// === 供应商查询 ===
|
||||
|
||||
/**
|
||||
* 获取供应商配置
|
||||
*/
|
||||
getProvider(providerId: string): ProviderConfig | null
|
||||
|
||||
/**
|
||||
* 检查供应商能力
|
||||
*/
|
||||
hasProviderCapability(providerId: string, capability: ProviderCapability): boolean
|
||||
|
||||
/**
|
||||
* 检查端点支持
|
||||
*/
|
||||
supportsEndpoint(providerId: string, endpoint: EndpointType): boolean
|
||||
|
||||
/**
|
||||
* 查找供应商
|
||||
*/
|
||||
findProviders(filter?: ProviderFilter): ProviderConfig[]
|
||||
|
||||
// === 内部方法 ===
|
||||
|
||||
/**
|
||||
* 应用覆盖配置
|
||||
*/
|
||||
private applyOverrides(model: ModelConfig, providerId: string): ModelConfig
|
||||
}
|
||||
|
||||
// 统一导出
|
||||
export const catalog = new CatalogService()
|
||||
|
||||
// 向后兼容的辅助函数
|
||||
export const isFunctionCallingModel = (model: Model): boolean =>
|
||||
catalog.hasCapability(model.id, 'FUNCTION_CALL', model.provider)
|
||||
|
||||
export const isReasoningModel = (model: Model): boolean =>
|
||||
catalog.hasCapability(model.id, 'REASONING', model.provider)
|
||||
|
||||
export const isVisionModel = (model: Model): boolean =>
|
||||
catalog.hasCapability(model.id, 'IMAGE_RECOGNITION', model.provider)
|
||||
```
|
||||
|
||||
## 📊 JSON 配置示例
|
||||
|
||||
### 模型配置示例
|
||||
|
||||
```json
|
||||
// packages/catalog/src/data/models.json
|
||||
{
|
||||
"version": "2025.11.24",
|
||||
"models": [
|
||||
{
|
||||
"id": "claude-3-5-sonnet-20241022",
|
||||
"name": "Claude 3.5 Sonnet",
|
||||
"owned_by": "anthropic",
|
||||
"capabilities": [
|
||||
"FUNCTION_CALL",
|
||||
"REASONING",
|
||||
"IMAGE_RECOGNITION",
|
||||
"STRUCTURED_OUTPUT",
|
||||
"FILE_INPUT"
|
||||
],
|
||||
"input_modalities": ["TEXT", "VISION"],
|
||||
"output_modalities": ["TEXT"],
|
||||
"context_window": 200000,
|
||||
"max_output_tokens": 8192,
|
||||
"pricing": {
|
||||
"input": { "per_million_tokens": 3.0, "currency": "USD" },
|
||||
"output": { "per_million_tokens": 15.0, "currency": "USD" }
|
||||
},
|
||||
"reasoning": {
|
||||
"type": "anthropic",
|
||||
"params": {
|
||||
"type": "enabled",
|
||||
"budgetTokens": 10000
|
||||
}
|
||||
},
|
||||
"parameters": {
|
||||
"temperature": {
|
||||
"supported": true,
|
||||
"min": 0.0,
|
||||
"max": 1.0,
|
||||
"default": 1.0
|
||||
}
|
||||
},
|
||||
"metadata": {}
|
||||
},
|
||||
{
|
||||
"id": "gpt-4-turbo",
|
||||
"name": "GPT-4 Turbo",
|
||||
"owned_by": "openai",
|
||||
"capabilities": [
|
||||
"FUNCTION_CALL",
|
||||
"IMAGE_RECOGNITION",
|
||||
"STRUCTURED_OUTPUT"
|
||||
],
|
||||
"input_modalities": ["TEXT", "VISION"],
|
||||
"output_modalities": ["TEXT"],
|
||||
"context_window": 128000,
|
||||
"max_output_tokens": 4096,
|
||||
"pricing": {
|
||||
"input": { "per_million_tokens": 10.0, "currency": "USD" },
|
||||
"output": { "per_million_tokens": 30.0, "currency": "USD" }
|
||||
},
|
||||
"metadata": {}
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
### 供应商配置示例
|
||||
|
||||
```json
|
||||
// packages/catalog/src/data/providers.json
|
||||
{
|
||||
"version": "2025.11.24",
|
||||
"providers": [
|
||||
{
|
||||
"id": "anthropic",
|
||||
"name": "Anthropic",
|
||||
"authentication": "API_KEY",
|
||||
"pricing_model": "PER_MODEL",
|
||||
"model_routing": "DIRECT",
|
||||
"behaviors": {
|
||||
"supports_custom_models": false,
|
||||
"provides_model_mapping": false,
|
||||
"supports_streaming": true,
|
||||
"has_real_time_metrics": true,
|
||||
"supports_rate_limiting": true,
|
||||
"provides_usage_analytics": true,
|
||||
"requires_api_key_validation": true
|
||||
},
|
||||
"supported_endpoints": ["MESSAGES"],
|
||||
"api_compatibility": {
|
||||
"supports_stream_options": true,
|
||||
"supports_parallel_tools": true,
|
||||
"supports_multimodal": true
|
||||
},
|
||||
"default_api_host": "https://api.anthropic.com",
|
||||
"deprecated": false,
|
||||
"maintenance_mode": false,
|
||||
"config_version": "1.0.0",
|
||||
"special_config": {},
|
||||
"metadata": {}
|
||||
},
|
||||
{
|
||||
"id": "openrouter",
|
||||
"name": "OpenRouter",
|
||||
"authentication": "API_KEY",
|
||||
"pricing_model": "UNIFIED",
|
||||
"model_routing": "INTELLIGENT",
|
||||
"behaviors": {
|
||||
"supports_custom_models": true,
|
||||
"provides_model_mapping": true,
|
||||
"provides_fallback_routing": true,
|
||||
"has_auto_retry": true,
|
||||
"supports_streaming": true,
|
||||
"has_real_time_metrics": true
|
||||
},
|
||||
"supported_endpoints": ["CHAT_COMPLETIONS"],
|
||||
"default_api_host": "https://openrouter.ai/api/v1",
|
||||
"deprecated": false,
|
||||
"maintenance_mode": false,
|
||||
"config_version": "1.0.0",
|
||||
"special_config": {},
|
||||
"metadata": {}
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
### 覆盖配置示例
|
||||
|
||||
```json
|
||||
// packages/catalog/src/data/overrides.json
|
||||
{
|
||||
"version": "2025.11.24",
|
||||
"overrides": [
|
||||
{
|
||||
"provider_id": "openrouter",
|
||||
"model_id": "claude-3-5-sonnet-20241022",
|
||||
"pricing": {
|
||||
"input": { "per_million_tokens": 4.5, "currency": "USD" },
|
||||
"output": { "per_million_tokens": 22.5, "currency": "USD" }
|
||||
},
|
||||
"capabilities": {
|
||||
"add": ["WEB_SEARCH"]
|
||||
},
|
||||
"reason": "OpenRouter applies markup and adds web search",
|
||||
"priority": 0
|
||||
},
|
||||
{
|
||||
"provider_id": "openrouter",
|
||||
"model_id": "gpt-4-turbo",
|
||||
"limits": {
|
||||
"context_window": 128000,
|
||||
"max_output_tokens": 16384
|
||||
},
|
||||
"reason": "OpenRouter extends output token limit",
|
||||
"priority": 0
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## 🔄 实现计划
|
||||
|
||||
### Phase 1: 基础架构 (2-3 days)
|
||||
|
||||
**目标**:建立核心架构和类型系统
|
||||
|
||||
**任务**:
|
||||
1. **Schema 定义**
|
||||
- 实现 `model.schema.ts`、`provider.schema.ts`、`override.schema.ts`
|
||||
- 所有 Schema 使用 Zod 验证
|
||||
- 导出 TypeScript 类型
|
||||
|
||||
2. **配置加载器**
|
||||
```typescript
|
||||
// packages/catalog/src/services/ConfigLoader.ts
|
||||
export class ConfigLoader {
|
||||
loadModels(): ModelConfig[]
|
||||
loadProviders(): ProviderConfig[]
|
||||
loadOverrides(): ProviderModelOverride[]
|
||||
validate(): boolean
|
||||
}
|
||||
```
|
||||
|
||||
3. **目录服务**
|
||||
```typescript
|
||||
// packages/catalog/src/services/CatalogService.ts
|
||||
export class CatalogService {
|
||||
// 实现所有查询 API
|
||||
}
|
||||
```
|
||||
|
||||
**验收标准**:
|
||||
- ✅ 所有 Schema 定义完成,通过 Zod 验证
|
||||
- ✅ ConfigLoader 可以加载和验证 JSON 文件
|
||||
- ✅ CatalogService 基础 API 实现
|
||||
- ✅ 单元测试覆盖核心功能
|
||||
|
||||
### Phase 2: 数据迁移 (1-2 days)
|
||||
|
||||
**目标**:从现有硬编码逻辑生成 JSON 配置
|
||||
|
||||
**任务**:
|
||||
1. **迁移工具**
|
||||
```typescript
|
||||
// packages/catalog/src/utils/migrate.ts
|
||||
export class MigrationTool {
|
||||
// 从 src/renderer/src/config/models/ 提取模型配置
|
||||
extractModelConfigs(): ModelConfig[]
|
||||
|
||||
// 提取供应商配置
|
||||
extractProviderConfigs(): ProviderConfig[]
|
||||
|
||||
// 写入 JSON 文件
|
||||
writeConfigs(models: ModelConfig[], providers: ProviderConfig[]): void
|
||||
|
||||
// 简单验证
|
||||
validate(): boolean
|
||||
}
|
||||
```
|
||||
|
||||
2. **迁移脚本**
|
||||
```bash
|
||||
# 运行迁移
|
||||
yarn catalog:migrate
|
||||
```
|
||||
|
||||
3. **手动审核**
|
||||
- 检查生成的配置文件
|
||||
- 补充缺失的价格和限制信息
|
||||
- 调整不准确的能力定义
|
||||
|
||||
**验收标准**:
|
||||
- ✅ 迁移工具能够提取现有配置
|
||||
- ✅ 生成的配置通过 Schema 验证
|
||||
- ✅ 手动审核完成,配置准确
|
||||
|
||||
### Phase 3: 集成替换 (2-3 days)
|
||||
|
||||
**目标**:替换现有硬编码逻辑
|
||||
|
||||
**任务**:
|
||||
1. **向后兼容层**
|
||||
```typescript
|
||||
// packages/catalog/src/index.ts
|
||||
export const isFunctionCallingModel = (model: Model): boolean =>
|
||||
catalog.hasCapability(model.id, 'FUNCTION_CALL', model.provider)
|
||||
```
|
||||
|
||||
2. **逐步替换**
|
||||
- 替换 `src/renderer/src/config/models/` 中的函数
|
||||
- 更新所有调用点
|
||||
- 确保测试通过
|
||||
|
||||
3. **集成测试**
|
||||
- 端到端测试
|
||||
- 性能测试
|
||||
- 兼容性测试
|
||||
|
||||
**验收标准**:
|
||||
- ✅ 所有现有测试通过
|
||||
- ✅ 新配置系统与旧系统行为一致
|
||||
- ✅ 性能不低于原有实现
|
||||
|
||||
### 延迟实现 ⏸️
|
||||
|
||||
以下功能在初期版本不实现,等待实际需求:
|
||||
|
||||
- ⏸️ **在线配置更新**:等到有用户需求再实现
|
||||
- ⏸️ **复杂缓存机制**:等出现性能问题再优化
|
||||
- ⏸️ **配置版本控制**:简化为文件级别的版本号
|
||||
|
||||
## 🧪 测试策略
|
||||
|
||||
### 测试覆盖
|
||||
|
||||
1. **Schema 测试**
|
||||
```typescript
|
||||
describe('ModelConfig Schema', () => {
|
||||
it('validates correct config', () => {
|
||||
expect(() => ModelConfigSchema.parse(validConfig)).not.toThrow()
|
||||
})
|
||||
|
||||
it('rejects invalid config', () => {
|
||||
expect(() => ModelConfigSchema.parse(invalidConfig)).toThrow()
|
||||
})
|
||||
})
|
||||
```
|
||||
|
||||
2. **服务测试**
|
||||
```typescript
|
||||
describe('CatalogService', () => {
|
||||
it('returns model with overrides applied', () => {
|
||||
const model = catalog.getModel('claude-3-5-sonnet', 'openrouter')
|
||||
expect(model?.pricing).toEqual(expectedPricing)
|
||||
})
|
||||
|
||||
it('checks capabilities correctly', () => {
|
||||
expect(catalog.hasCapability('gpt-4', 'FUNCTION_CALL')).toBe(true)
|
||||
})
|
||||
})
|
||||
```
|
||||
|
||||
3. **兼容性测试**
|
||||
```typescript
|
||||
describe('Backward Compatibility', () => {
|
||||
it('produces same results as legacy', () => {
|
||||
expect(isFunctionCallingModel(testModel)).toBe(legacyResult)
|
||||
})
|
||||
})
|
||||
```
|
||||
|
||||
## 📖 使用指南
|
||||
|
||||
### 基本用法
|
||||
|
||||
```typescript
|
||||
import { catalog } from '@cherrystudio/catalog'
|
||||
|
||||
// 检查模型能力
|
||||
const canCallFunctions = catalog.hasCapability('gpt-4', 'FUNCTION_CALL')
|
||||
const canReason = catalog.hasCapability('o1-preview', 'REASONING')
|
||||
|
||||
// 获取模型配置
|
||||
const modelConfig = catalog.getModel('claude-3-5-sonnet', 'openrouter')
|
||||
|
||||
// 查找模型
|
||||
const visionModels = catalog.findModels({
|
||||
capabilities: ['IMAGE_RECOGNITION'],
|
||||
providers: ['anthropic', 'openai']
|
||||
})
|
||||
|
||||
// 检查供应商能力
|
||||
const hasMapping = catalog.hasProviderCapability('openrouter', 'MODEL_MAPPING')
|
||||
```
|
||||
|
||||
### 供应商查询
|
||||
|
||||
```typescript
|
||||
// 查找具有特定能力的供应商
|
||||
const providersWithFallback = catalog.findProviders({
|
||||
capabilities: ['FALLBACK_ROUTING', 'AUTO_RETRY']
|
||||
})
|
||||
|
||||
// 查找统一定价的供应商
|
||||
const unifiedPricingProviders = catalog.findProviders({
|
||||
pricingModel: 'UNIFIED'
|
||||
})
|
||||
```
|
||||
|
||||
## 📝 维护指南
|
||||
|
||||
### 添加新模型
|
||||
|
||||
1. 编辑对应的模型配置文件
|
||||
2. 添加模型信息
|
||||
3. 运行验证:`yarn catalog:validate`
|
||||
4. 提交 PR
|
||||
|
||||
### 添加新供应商
|
||||
|
||||
1. 编辑 `providers.json`
|
||||
2. 添加供应商配置
|
||||
3. 如需覆盖,添加到 `overrides.json`
|
||||
4. 验证并提交
|
||||
|
||||
## 🔧 开发工具
|
||||
|
||||
### 命令行
|
||||
|
||||
```json
|
||||
{
|
||||
"scripts": {
|
||||
"catalog:validate": "tsx scripts/validate.ts",
|
||||
"catalog:migrate": "tsx scripts/migrate.ts",
|
||||
"catalog:test": "vitest run",
|
||||
"catalog:build": "tsdown"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## 📚 迁移对照表
|
||||
|
||||
| 旧函数 | 新 API |
|
||||
|--------|--------|
|
||||
| `isFunctionCallingModel(model)` | `catalog.hasCapability(model.id, 'FUNCTION_CALL', model.provider)` |
|
||||
| `isReasoningModel(model)` | `catalog.hasCapability(model.id, 'REASONING', model.provider)` |
|
||||
| `isVisionModel(model)` | `catalog.hasCapability(model.id, 'IMAGE_RECOGNITION', model.provider)` |
|
||||
| `getThinkModelType(model)` | `catalog.getReasoningConfig(model.id, model.provider)` |
|
||||
|
||||
## 📊 预期成果
|
||||
|
||||
### 时间估算
|
||||
- Phase 1: 2-3 天
|
||||
- Phase 2: 1-2 天
|
||||
- Phase 3: 2-3 天
|
||||
- **总计**: 5-8 天
|
||||
|
||||
### 性能目标
|
||||
- 配置加载时间: < 100ms
|
||||
- 模型查询时间: < 1ms
|
||||
- 内存使用: < 50MB
|
||||
|
||||
---
|
||||
|
||||
这个简化方案专注于核心功能,避免过度设计,遵循"保持简洁"的原则,为未来扩展留有空间。
|
||||
1
packages/catalog/README.md
Normal file
1
packages/catalog/README.md
Normal file
@@ -0,0 +1 @@
|
||||
# catalog
|
||||
627
packages/catalog/api/openapi.json
Normal file
627
packages/catalog/api/openapi.json
Normal file
@@ -0,0 +1,627 @@
|
||||
{
|
||||
"openapi": "3.0.3",
|
||||
"info": {
|
||||
"title": "Cherry Studio Catalog API",
|
||||
"description": "REST API for managing AI models and providers catalog",
|
||||
"version": "1.0.0",
|
||||
"contact": {
|
||||
"name": "Cherry Studio Team"
|
||||
}
|
||||
},
|
||||
"servers": [
|
||||
{
|
||||
"url": "http://localhost:3000/api",
|
||||
"description": "Development server"
|
||||
}
|
||||
],
|
||||
"paths": {
|
||||
"/catalog/models": {
|
||||
"get": {
|
||||
"summary": "List models with pagination and filtering",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "page",
|
||||
"in": "query",
|
||||
"schema": {
|
||||
"type": "integer",
|
||||
"minimum": 1,
|
||||
"default": 1
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "limit",
|
||||
"in": "query",
|
||||
"schema": {
|
||||
"type": "integer",
|
||||
"minimum": 1,
|
||||
"maximum": 100,
|
||||
"default": 20
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "search",
|
||||
"in": "query",
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "capabilities",
|
||||
"in": "query",
|
||||
"schema": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "providers",
|
||||
"in": "query",
|
||||
"schema": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Paginated list of models",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/PaginatedModels"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"put": {
|
||||
"summary": "Update models configuration",
|
||||
"requestBody": {
|
||||
"required": true,
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/ModelsConfig"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Models updated successfully"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/catalog/models/{modelId}": {
|
||||
"get": {
|
||||
"summary": "Get specific model details",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "modelId",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Model details",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/Model"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"put": {
|
||||
"summary": "Update specific model",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "modelId",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
],
|
||||
"requestBody": {
|
||||
"required": true,
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/Model"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Model updated successfully"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/catalog/providers": {
|
||||
"get": {
|
||||
"summary": "List providers with pagination and filtering",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "page",
|
||||
"in": "query",
|
||||
"schema": {
|
||||
"type": "integer",
|
||||
"minimum": 1,
|
||||
"default": 1
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "limit",
|
||||
"in": "query",
|
||||
"schema": {
|
||||
"type": "integer",
|
||||
"minimum": 1,
|
||||
"maximum": 100,
|
||||
"default": 20
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "search",
|
||||
"in": "query",
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "authentication",
|
||||
"in": "query",
|
||||
"schema": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Paginated list of providers",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/PaginatedProviders"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"put": {
|
||||
"summary": "Update providers configuration",
|
||||
"requestBody": {
|
||||
"required": true,
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/ProvidersConfig"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Providers updated successfully"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/catalog/providers/{providerId}": {
|
||||
"get": {
|
||||
"summary": "Get specific provider details",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "providerId",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Provider details",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/Provider"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/catalog/models/{modelId}/overrides": {
|
||||
"get": {
|
||||
"summary": "Get provider-specific overrides for a model",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "modelId",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Provider overrides for the model",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"additionalProperties": {
|
||||
"$ref": "#/components/schemas/Model"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/catalog/models/{modelId}/providers/{providerId}": {
|
||||
"get": {
|
||||
"summary": "Get model configuration as seen by specific provider",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "modelId",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "providerId",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Model configuration with provider-specific overrides applied",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/Model"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"put": {
|
||||
"summary": "Update model configuration for specific provider (auto-detects if override is needed)",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "modelId",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "providerId",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
],
|
||||
"requestBody": {
|
||||
"required": true,
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/Model"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Model configuration updated (override created/updated if needed)",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"updated": {
|
||||
"type": "string",
|
||||
"enum": ["base_model", "override", "both"]
|
||||
},
|
||||
"model": {
|
||||
"$ref": "#/components/schemas/Model"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/catalog/stats": {
|
||||
"get": {
|
||||
"summary": "Get catalog statistics",
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Catalog statistics",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/CatalogStats"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/catalog/validate": {
|
||||
"post": {
|
||||
"summary": "Validate catalog configuration",
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Validation results",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/ValidationResult"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"components": {
|
||||
"schemas": {
|
||||
"Model": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": { "type": "string" },
|
||||
"name": { "type": "string" },
|
||||
"owned_by": { "type": "string" },
|
||||
"capabilities": {
|
||||
"type": "array",
|
||||
"items": { "type": "string" }
|
||||
},
|
||||
"input_modalities": {
|
||||
"type": "array",
|
||||
"items": { "type": "string" }
|
||||
},
|
||||
"output_modalities": {
|
||||
"type": "array",
|
||||
"items": { "type": "string" }
|
||||
},
|
||||
"context_window": { "type": "integer" },
|
||||
"max_output_tokens": { "type": "integer" },
|
||||
"max_input_tokens": { "type": "integer" },
|
||||
"pricing": {
|
||||
"$ref": "#/components/schemas/Pricing"
|
||||
},
|
||||
"parameters": {
|
||||
"$ref": "#/components/schemas/Parameters"
|
||||
},
|
||||
"endpoint_types": {
|
||||
"type": "array",
|
||||
"items": { "type": "string" }
|
||||
},
|
||||
"metadata": { "type": "object" }
|
||||
}
|
||||
},
|
||||
"Provider": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": { "type": "string" },
|
||||
"name": { "type": "string" },
|
||||
"description": { "type": "string" },
|
||||
"authentication": { "type": "string" },
|
||||
"pricing_model": { "type": "string" },
|
||||
"model_routing": { "type": "string" },
|
||||
"behaviors": { "type": "object" },
|
||||
"supported_endpoints": {
|
||||
"type": "array",
|
||||
"items": { "type": "string" }
|
||||
},
|
||||
"api_compatibility": { "type": "object" },
|
||||
"special_config": { "type": "object" },
|
||||
"documentation": { "type": "string" },
|
||||
"website": { "type": "string" },
|
||||
"deprecated": { "type": "boolean" },
|
||||
"maintenance_mode": { "type": "boolean" },
|
||||
"config_version": { "type": "string" },
|
||||
"metadata": { "type": "object" }
|
||||
}
|
||||
},
|
||||
"Override": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"provider_id": { "type": "string" },
|
||||
"model_id": { "type": "string" },
|
||||
"disabled": { "type": "boolean" },
|
||||
"reason": { "type": "string" },
|
||||
"last_updated": { "type": "string" },
|
||||
"updated_by": { "type": "string" },
|
||||
"priority": { "type": "integer" },
|
||||
"limits": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"context_window": { "type": "integer" },
|
||||
"max_output_tokens": { "type": "integer" }
|
||||
}
|
||||
},
|
||||
"pricing": {
|
||||
"$ref": "#/components/schemas/Pricing"
|
||||
}
|
||||
}
|
||||
},
|
||||
"Pricing": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"input": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"per_million_tokens": { "type": "number" },
|
||||
"currency": { "type": "string" }
|
||||
}
|
||||
},
|
||||
"output": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"per_million_tokens": { "type": "number" },
|
||||
"currency": { "type": "string" }
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"Parameters": {
|
||||
"type": "object",
|
||||
"additionalProperties": true
|
||||
},
|
||||
"PaginatedModels": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"data": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/Model"
|
||||
}
|
||||
},
|
||||
"pagination": {
|
||||
"$ref": "#/components/schemas/Pagination"
|
||||
}
|
||||
}
|
||||
},
|
||||
"PaginatedProviders": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"data": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/Provider"
|
||||
}
|
||||
},
|
||||
"pagination": {
|
||||
"$ref": "#/components/schemas/Pagination"
|
||||
}
|
||||
}
|
||||
},
|
||||
"PaginatedOverrides": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"data": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/Override"
|
||||
}
|
||||
},
|
||||
"pagination": {
|
||||
"$ref": "#/components/schemas/Pagination"
|
||||
}
|
||||
}
|
||||
},
|
||||
"Pagination": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"page": { "type": "integer" },
|
||||
"limit": { "type": "integer" },
|
||||
"total": { "type": "integer" },
|
||||
"totalPages": { "type": "integer" }
|
||||
}
|
||||
},
|
||||
"ModelsConfig": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"version": { "type": "string" },
|
||||
"models": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/Model"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"ProvidersConfig": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"version": { "type": "string" },
|
||||
"providers": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/Provider"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"OverridesConfig": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"version": { "type": "string" },
|
||||
"overrides": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/Override"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"CatalogStats": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"total_models": { "type": "integer" },
|
||||
"total_providers": { "type": "integer" },
|
||||
"total_overrides": { "type": "integer" },
|
||||
"models_by_provider": { "type": "object" },
|
||||
"overrides_by_provider": { "type": "object" },
|
||||
"last_updated": { "type": "string" }
|
||||
}
|
||||
},
|
||||
"ValidationResult": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"valid": { "type": "boolean" },
|
||||
"errors": {
|
||||
"type": "array",
|
||||
"items": { "type": "string" }
|
||||
},
|
||||
"warnings": {
|
||||
"type": "array",
|
||||
"items": { "type": "string" }
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
88
packages/catalog/data/migration-report.json
Normal file
88
packages/catalog/data/migration-report.json
Normal file
@@ -0,0 +1,88 @@
|
||||
{
|
||||
"timestamp": "2025-11-24T06:41:03.487Z",
|
||||
"summary": {
|
||||
"total_providers": 104,
|
||||
"total_base_models": 241,
|
||||
"total_overrides": 1164,
|
||||
"provider_categories": {
|
||||
"direct": 2,
|
||||
"cloud": 6,
|
||||
"proxy": 3,
|
||||
"self_hosted": 5
|
||||
},
|
||||
"models_by_provider": {
|
||||
"openai": 79,
|
||||
"anthropic": 20,
|
||||
"dashscope": 22,
|
||||
"deepseek": 7,
|
||||
"gemini": 50,
|
||||
"mistral": 31,
|
||||
"xai": 32
|
||||
},
|
||||
"overrides_by_provider": {
|
||||
"bedrock": 152,
|
||||
"bedrock_converse": 56,
|
||||
"anyscale": 12,
|
||||
"azure": 112,
|
||||
"azure_ai": 45,
|
||||
"cerebras": 5,
|
||||
"vertex_ai-chat-models": 5,
|
||||
"nlp_cloud": 1,
|
||||
"cloudflare": 4,
|
||||
"vertex_ai-code-text-models": 1,
|
||||
"vertex_ai-code-chat-models": 6,
|
||||
"codestral": 2,
|
||||
"cohere_chat": 7,
|
||||
"databricks": 9,
|
||||
"deepinfra": 67,
|
||||
"featherless_ai": 2,
|
||||
"fireworks_ai": 27,
|
||||
"friendliai": 2,
|
||||
"openai": 8,
|
||||
"vertex_ai-language-models": 46,
|
||||
"vertex_ai-vision-models": 3,
|
||||
"gradient_ai": 13,
|
||||
"groq": 27,
|
||||
"heroku": 4,
|
||||
"hyperbolic": 16,
|
||||
"ai21": 9,
|
||||
"lambda_ai": 20,
|
||||
"lemonade": 5,
|
||||
"aleph_alpha": 3,
|
||||
"meta_llama": 4,
|
||||
"moonshot": 17,
|
||||
"morph": 2,
|
||||
"nscale": 14,
|
||||
"oci": 13,
|
||||
"ollama": 21,
|
||||
"openrouter": 92,
|
||||
"ovhcloud": 15,
|
||||
"palm": 2,
|
||||
"perplexity": 25,
|
||||
"replicate": 13,
|
||||
"sagemaker": 3,
|
||||
"sambanova": 16,
|
||||
"snowflake": 24,
|
||||
"together_ai": 36,
|
||||
"v0": 3,
|
||||
"vercel_ai_gateway": 85,
|
||||
"vertex_ai-anthropic_models": 22,
|
||||
"vertex_ai-mistral_models": 19,
|
||||
"vertex_ai-deepseek_models": 2,
|
||||
"vertex_ai": 1,
|
||||
"vertex_ai-ai21_models": 5,
|
||||
"vertex_ai-llama_models": 11,
|
||||
"vertex_ai-minimax_models": 1,
|
||||
"vertex_ai-moonshot_models": 1,
|
||||
"vertex_ai-openai_models": 2,
|
||||
"vertex_ai-qwen_models": 4,
|
||||
"wandb": 14,
|
||||
"watsonx": 28
|
||||
}
|
||||
},
|
||||
"files": {
|
||||
"providers": "providers.json",
|
||||
"models": "models.json",
|
||||
"overrides": "overrides.json"
|
||||
}
|
||||
}
|
||||
9371
packages/catalog/data/models.json
Normal file
9371
packages/catalog/data/models.json
Normal file
File diff suppressed because it is too large
Load Diff
26365
packages/catalog/data/overrides.json
Normal file
26365
packages/catalog/data/overrides.json
Normal file
File diff suppressed because it is too large
Load Diff
4949
packages/catalog/data/providers.json
Normal file
4949
packages/catalog/data/providers.json
Normal file
File diff suppressed because it is too large
Load Diff
24586
packages/catalog/model_prices_and_context_window.json
Normal file
24586
packages/catalog/model_prices_and_context_window.json
Normal file
File diff suppressed because it is too large
Load Diff
54
packages/catalog/package.json
Normal file
54
packages/catalog/package.json
Normal file
@@ -0,0 +1,54 @@
|
||||
{
|
||||
"name": "@cherrystudio/catalog",
|
||||
"version": "0.0.1-alpha.1",
|
||||
"description": "All Model Catalog",
|
||||
"main": "dist/index.js",
|
||||
"module": "dist/index.mjs",
|
||||
"types": "dist/index.d.ts",
|
||||
"packageManager": "yarn@4.9.1",
|
||||
"scripts": {
|
||||
"build": "tsdown",
|
||||
"dev": "tsc -w",
|
||||
"clean": "rm -rf dist",
|
||||
"test": "vitest run",
|
||||
"test:watch": "vitest"
|
||||
},
|
||||
"author": "Cherry Studio",
|
||||
"license": "MIT",
|
||||
"files": [
|
||||
"dist/**/*"
|
||||
],
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://github.com/CherryHQ/cherry-studio.git"
|
||||
},
|
||||
"bugs": {
|
||||
"url": "https://github.com/CherryHQ/cherry-studio/issues"
|
||||
},
|
||||
"homepage": "https://github.com/CherryHQ/cherry-studio#readme",
|
||||
"exports": {
|
||||
".": {
|
||||
"types": "./dist/index.d.ts",
|
||||
"react-native": "./dist/index.js",
|
||||
"import": "./dist/index.mjs",
|
||||
"require": "./dist/index.js",
|
||||
"default": "./dist/index.js"
|
||||
}
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/json-schema": "^7.0.15",
|
||||
"tsdown": "^0.16.6",
|
||||
"typescript": "^5.9.3",
|
||||
"vitest": "^4.0.13",
|
||||
"zod": "^4.1.12"
|
||||
},
|
||||
"peerDependencies": {
|
||||
"zod": "^4.1.12"
|
||||
},
|
||||
"dependencies": {
|
||||
"json-schema": "^0.4.0"
|
||||
},
|
||||
"workspaces": [
|
||||
"web"
|
||||
]
|
||||
}
|
||||
1701
packages/catalog/provider_endpoints_support.json
Normal file
1701
packages/catalog/provider_endpoints_support.json
Normal file
File diff suppressed because it is too large
Load Diff
39
packages/catalog/scripts/migrate.ts
Normal file
39
packages/catalog/scripts/migrate.ts
Normal file
@@ -0,0 +1,39 @@
|
||||
#!/usr/bin/env tsx
|
||||
|
||||
/**
|
||||
* Migration Script - Phase 2 Implementation
|
||||
* Usage: npx tsx migrate.ts
|
||||
*/
|
||||
|
||||
import * as path from 'path'
|
||||
|
||||
import { MigrationTool } from '../src/utils/migration'
|
||||
|
||||
async function main() {
|
||||
const packageRoot = path.resolve(__dirname, '..')
|
||||
const sourceDir = packageRoot
|
||||
const outputDir = path.join(packageRoot, 'data')
|
||||
|
||||
console.log('🔧 Cherry Studio Catalog Migration - Phase 2')
|
||||
console.log('==========================================')
|
||||
console.log(`📁 Source: ${sourceDir}`)
|
||||
console.log(`📁 Output: ${outputDir}`)
|
||||
console.log('')
|
||||
|
||||
const tool = new MigrationTool(
|
||||
path.join(sourceDir, 'provider_endpoints_support.json'),
|
||||
path.join(sourceDir, 'model_prices_and_context_window.json'),
|
||||
outputDir
|
||||
)
|
||||
|
||||
try {
|
||||
await tool.migrate()
|
||||
console.log('')
|
||||
console.log('🎉 Migration completed! Check the src/data/ directory for results.')
|
||||
} catch (error) {
|
||||
console.error('❌ Migration failed:', error)
|
||||
process.exit(1)
|
||||
}
|
||||
}
|
||||
|
||||
main()
|
||||
@@ -0,0 +1,240 @@
|
||||
// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
|
||||
|
||||
exports[`Config & Schema > Snapshot Tests > should snapshot complete configuration structure 1`] = `
|
||||
{
|
||||
"models": Any<Array>,
|
||||
"overrides": Any<Array>,
|
||||
"providers": Any<Array>,
|
||||
}
|
||||
`;
|
||||
|
||||
exports[`Config & Schema > Snapshot Tests > should snapshot model configurations 1`] = `
|
||||
[
|
||||
{
|
||||
"capabilities": [
|
||||
"FUNCTION_CALL",
|
||||
"REASONING",
|
||||
],
|
||||
"contextWindow": 128000,
|
||||
"description": "A test model for unit testing",
|
||||
"endpointTypes": [
|
||||
"CHAT_COMPLETIONS",
|
||||
],
|
||||
"id": "test-model",
|
||||
"inputModalities": [
|
||||
"TEXT",
|
||||
],
|
||||
"maxInputTokens": 124000,
|
||||
"maxOutputTokens": 4096,
|
||||
"metadata": {
|
||||
"architecture": "transformer",
|
||||
"category": "language-model",
|
||||
"documentation": "https://docs.test.com/models/test-model",
|
||||
"family": "test-family",
|
||||
"license": "mit",
|
||||
"source": "test",
|
||||
"tags": [
|
||||
"test",
|
||||
"fast",
|
||||
"reliable",
|
||||
],
|
||||
"trainingData": "synthetic",
|
||||
},
|
||||
"name": "Test Model",
|
||||
"outputModalities": [
|
||||
"TEXT",
|
||||
],
|
||||
"ownedBy": "TestProvider",
|
||||
"parameters": {
|
||||
"maxTokens": true,
|
||||
"systemMessage": true,
|
||||
"temperature": {
|
||||
"default": 1,
|
||||
"max": 2,
|
||||
"min": 0,
|
||||
"supported": true,
|
||||
},
|
||||
"topP": {
|
||||
"default": 1,
|
||||
"max": 1,
|
||||
"min": 0,
|
||||
"supported": true,
|
||||
},
|
||||
},
|
||||
"pricing": {
|
||||
"input": {
|
||||
"currency": "USD",
|
||||
"perMillionTokens": 1,
|
||||
},
|
||||
"output": {
|
||||
"currency": "USD",
|
||||
"perMillionTokens": 2,
|
||||
},
|
||||
},
|
||||
},
|
||||
]
|
||||
`;
|
||||
|
||||
exports[`Config & Schema > Snapshot Tests > should snapshot override configurations 1`] = `
|
||||
[
|
||||
{
|
||||
"capabilities": {
|
||||
"add": [
|
||||
"FUNCTION_CALL",
|
||||
],
|
||||
"remove": [
|
||||
"REASONING",
|
||||
],
|
||||
},
|
||||
"disabled": false,
|
||||
"lastUpdated": "2025-11-24T07:08:00Z",
|
||||
"limits": {
|
||||
"contextWindow": 256000,
|
||||
"maxOutputTokens": 8192,
|
||||
},
|
||||
"modelId": "test-model",
|
||||
"pricing": {
|
||||
"input": {
|
||||
"currency": "USD",
|
||||
"perMillionTokens": 0.5,
|
||||
},
|
||||
},
|
||||
"priority": 100,
|
||||
"providerId": "test-provider",
|
||||
"reason": "Test override for enhanced capabilities and limits",
|
||||
"updatedBy": "test-suite",
|
||||
},
|
||||
]
|
||||
`;
|
||||
|
||||
exports[`Config & Schema > Snapshot Tests > should snapshot provider configurations 1`] = `
|
||||
[
|
||||
{
|
||||
"apiCompatibility": {
|
||||
"supportsApiVersion": false,
|
||||
"supportsArrayContent": true,
|
||||
"supportsDeveloperRole": false,
|
||||
"supportsMultimodal": false,
|
||||
"supportsParallelTools": false,
|
||||
"supportsServiceTier": false,
|
||||
"supportsStreamOptions": false,
|
||||
"supportsThinkingControl": false,
|
||||
},
|
||||
"authentication": "API_KEY",
|
||||
"behaviors": {
|
||||
"hasAutoRetry": false,
|
||||
"hasRealTimeMetrics": false,
|
||||
"providesFallbackRouting": false,
|
||||
"providesModelMapping": false,
|
||||
"providesUsageAnalytics": false,
|
||||
"providesUsageLimits": false,
|
||||
"requiresApiKeyValidation": true,
|
||||
"supportsBatchProcessing": false,
|
||||
"supportsCustomModels": false,
|
||||
"supportsHealthCheck": false,
|
||||
"supportsModelFineTuning": false,
|
||||
"supportsModelVersioning": false,
|
||||
"supportsRateLimiting": false,
|
||||
"supportsStreaming": true,
|
||||
"supportsWebhookEvents": false,
|
||||
},
|
||||
"configVersion": "1.0.0",
|
||||
"deprecated": false,
|
||||
"description": "A test provider for unit testing",
|
||||
"documentation": "https://docs.test.com",
|
||||
"id": "test-provider",
|
||||
"maintenanceMode": false,
|
||||
"metadata": {
|
||||
"category": "ai-provider",
|
||||
"reliability": "high",
|
||||
"source": "test",
|
||||
"supportedLanguages": [
|
||||
"en",
|
||||
],
|
||||
"tags": [
|
||||
"test",
|
||||
],
|
||||
},
|
||||
"modelRouting": "DIRECT",
|
||||
"name": "Test Provider",
|
||||
"pricingModel": "PER_MODEL",
|
||||
"specialConfig": {},
|
||||
"supportedEndpoints": [
|
||||
"CHAT_COMPLETIONS",
|
||||
],
|
||||
"website": "https://test.com",
|
||||
},
|
||||
]
|
||||
`;
|
||||
|
||||
exports[`Config & Schema > Snapshot Tests > should snapshot validation results 1`] = `
|
||||
{
|
||||
"data": {
|
||||
"capabilities": [
|
||||
"FUNCTION_CALL",
|
||||
"REASONING",
|
||||
],
|
||||
"contextWindow": 128000,
|
||||
"description": "A test model for unit testing",
|
||||
"endpointTypes": [
|
||||
"CHAT_COMPLETIONS",
|
||||
],
|
||||
"id": "test-model",
|
||||
"inputModalities": [
|
||||
"TEXT",
|
||||
],
|
||||
"maxInputTokens": 124000,
|
||||
"maxOutputTokens": 4096,
|
||||
"metadata": {
|
||||
"architecture": "transformer",
|
||||
"category": "language-model",
|
||||
"documentation": "https://docs.test.com/models/test-model",
|
||||
"family": "test-family",
|
||||
"license": "mit",
|
||||
"source": "test",
|
||||
"tags": [
|
||||
"test",
|
||||
"fast",
|
||||
"reliable",
|
||||
],
|
||||
"trainingData": "synthetic",
|
||||
},
|
||||
"name": "Test Model",
|
||||
"outputModalities": [
|
||||
"TEXT",
|
||||
],
|
||||
"ownedBy": "TestProvider",
|
||||
"parameters": {
|
||||
"maxTokens": true,
|
||||
"systemMessage": true,
|
||||
"temperature": {
|
||||
"default": 1,
|
||||
"max": 2,
|
||||
"min": 0,
|
||||
"supported": true,
|
||||
},
|
||||
"topP": {
|
||||
"default": 1,
|
||||
"max": 1,
|
||||
"min": 0,
|
||||
"supported": true,
|
||||
},
|
||||
},
|
||||
"pricing": {
|
||||
"input": {
|
||||
"currency": "USD",
|
||||
"perMillionTokens": 1,
|
||||
},
|
||||
"output": {
|
||||
"currency": "USD",
|
||||
"perMillionTokens": 2,
|
||||
},
|
||||
},
|
||||
},
|
||||
"success": true,
|
||||
"warnings": [
|
||||
"Model has REASONING capability but no reasoning configuration",
|
||||
"Custom validation warning for snapshot",
|
||||
],
|
||||
}
|
||||
`;
|
||||
381
packages/catalog/src/__tests__/catalog.test.ts
Normal file
381
packages/catalog/src/__tests__/catalog.test.ts
Normal file
@@ -0,0 +1,381 @@
|
||||
import * as path from 'path'
|
||||
import { describe, expect, it } from 'vitest'
|
||||
|
||||
import { ConfigLoader } from '../loader/ConfigLoader'
|
||||
import { SchemaValidator } from '../validator/SchemaValidator'
|
||||
|
||||
// Use fixtures directory for test data
|
||||
const fixturesPath = path.join(__dirname, 'fixtures')
|
||||
|
||||
describe('Config & Schema', () => {
|
||||
describe('ConfigLoader', () => {
|
||||
it('should load models with complete validation', async () => {
|
||||
const loader = new ConfigLoader({
|
||||
basePath: fixturesPath,
|
||||
validateOnLoad: true,
|
||||
cacheEnabled: false
|
||||
})
|
||||
|
||||
const models = await loader.loadModels('test-models.json')
|
||||
expect(models).toBeDefined()
|
||||
expect(Array.isArray(models)).toBe(true)
|
||||
expect(models).toHaveLength(1)
|
||||
|
||||
const model = models[0]
|
||||
expect(model).toStrictEqual({
|
||||
id: 'test-model',
|
||||
name: 'Test Model',
|
||||
ownedBy: 'TestProvider',
|
||||
description: 'A test model for unit testing',
|
||||
capabilities: ['FUNCTION_CALL', 'REASONING'],
|
||||
inputModalities: ['TEXT'],
|
||||
outputModalities: ['TEXT'],
|
||||
contextWindow: 128000,
|
||||
maxOutputTokens: 4096,
|
||||
maxInputTokens: 124000,
|
||||
pricing: {
|
||||
input: { perMillionTokens: 1, currency: 'USD' },
|
||||
output: { perMillionTokens: 2, currency: 'USD' }
|
||||
},
|
||||
parameters: {
|
||||
temperature: { supported: true, min: 0, max: 2, default: 1 },
|
||||
maxTokens: true,
|
||||
systemMessage: true,
|
||||
topP: { supported: true, min: 0, max: 1, default: 1 }
|
||||
},
|
||||
endpointTypes: ['CHAT_COMPLETIONS'],
|
||||
metadata: {
|
||||
tags: ['test', 'fast', 'reliable'],
|
||||
category: 'language-model',
|
||||
source: 'test',
|
||||
license: 'mit',
|
||||
documentation: 'https://docs.test.com/models/test-model',
|
||||
family: 'test-family',
|
||||
architecture: 'transformer',
|
||||
trainingData: 'synthetic'
|
||||
}
|
||||
})
|
||||
})
|
||||
|
||||
it('should load providers with complete validation', async () => {
|
||||
const loader = new ConfigLoader({
|
||||
basePath: fixturesPath,
|
||||
validateOnLoad: true,
|
||||
cacheEnabled: false
|
||||
})
|
||||
|
||||
const providers = await loader.loadProviders('test-providers.json')
|
||||
expect(providers).toBeDefined()
|
||||
expect(Array.isArray(providers)).toBe(true)
|
||||
expect(providers).toHaveLength(1)
|
||||
|
||||
const provider = providers[0]
|
||||
expect(provider).toStrictEqual({
|
||||
id: 'test-provider',
|
||||
name: 'Test Provider',
|
||||
description: 'A test provider for unit testing',
|
||||
authentication: 'API_KEY',
|
||||
pricingModel: 'PER_MODEL',
|
||||
modelRouting: 'DIRECT',
|
||||
behaviors: {
|
||||
supportsCustomModels: false,
|
||||
providesModelMapping: false,
|
||||
supportsModelVersioning: false,
|
||||
providesFallbackRouting: false,
|
||||
hasAutoRetry: false,
|
||||
supportsHealthCheck: false,
|
||||
hasRealTimeMetrics: false,
|
||||
providesUsageAnalytics: false,
|
||||
supportsWebhookEvents: false,
|
||||
requiresApiKeyValidation: true,
|
||||
supportsRateLimiting: false,
|
||||
providesUsageLimits: false,
|
||||
supportsStreaming: true,
|
||||
supportsBatchProcessing: false,
|
||||
supportsModelFineTuning: false
|
||||
},
|
||||
supportedEndpoints: ['CHAT_COMPLETIONS'],
|
||||
apiCompatibility: {
|
||||
supportsArrayContent: true,
|
||||
supportsStreamOptions: false,
|
||||
supportsDeveloperRole: false,
|
||||
supportsThinkingControl: false,
|
||||
supportsApiVersion: false,
|
||||
supportsParallelTools: false,
|
||||
supportsMultimodal: false,
|
||||
supportsServiceTier: false
|
||||
},
|
||||
specialConfig: {},
|
||||
documentation: 'https://docs.test.com',
|
||||
website: 'https://test.com',
|
||||
deprecated: false,
|
||||
maintenanceMode: false,
|
||||
configVersion: '1.0.0',
|
||||
metadata: {
|
||||
tags: ['test'],
|
||||
category: 'ai-provider',
|
||||
source: 'test',
|
||||
reliability: 'high',
|
||||
supportedLanguages: ['en']
|
||||
}
|
||||
})
|
||||
})
|
||||
|
||||
it('should load overrides with complete validation', async () => {
|
||||
const loader = new ConfigLoader({
|
||||
basePath: fixturesPath,
|
||||
validateOnLoad: true,
|
||||
cacheEnabled: false
|
||||
})
|
||||
|
||||
const overrides = await loader.loadOverrides('test-overrides.json')
|
||||
expect(overrides).toBeDefined()
|
||||
expect(Array.isArray(overrides)).toBe(true)
|
||||
expect(overrides).toHaveLength(1)
|
||||
|
||||
const override = overrides[0]
|
||||
expect(override).toMatchObject({
|
||||
providerId: 'test-provider',
|
||||
modelId: 'test-model',
|
||||
disabled: false,
|
||||
reason: 'Test override for enhanced capabilities and limits',
|
||||
priority: 100
|
||||
})
|
||||
|
||||
expect(override.capabilities?.add).toContain('FUNCTION_CALL')
|
||||
expect(override.capabilities?.remove).toContain('REASONING')
|
||||
expect(override.limits?.contextWindow).toBe(256000)
|
||||
expect(override.limits?.maxOutputTokens).toBe(8192)
|
||||
})
|
||||
|
||||
it('should load all configs simultaneously', async () => {
|
||||
const loader = new ConfigLoader({
|
||||
basePath: fixturesPath,
|
||||
validateOnLoad: true,
|
||||
cacheEnabled: false
|
||||
})
|
||||
|
||||
const configs = await loader.loadAllConfigs({
|
||||
modelsFile: 'test-models.json',
|
||||
providersFile: 'test-providers.json',
|
||||
overridesFile: 'test-overrides.json'
|
||||
})
|
||||
|
||||
expect(configs).toHaveProperty('models')
|
||||
expect(configs).toHaveProperty('providers')
|
||||
expect(configs).toHaveProperty('overrides')
|
||||
expect(configs.models).toHaveLength(1)
|
||||
expect(configs.providers).toHaveLength(1)
|
||||
expect(configs.overrides).toHaveLength(1)
|
||||
})
|
||||
|
||||
it('should handle missing files gracefully', async () => {
|
||||
const loader = new ConfigLoader({
|
||||
basePath: '/nonexistent/path'
|
||||
})
|
||||
|
||||
await expect(loader.loadModels('nonexistent.json')).rejects.toThrow('Failed to load models')
|
||||
})
|
||||
})
|
||||
|
||||
describe('SchemaValidator', () => {
|
||||
it('should validate valid model configuration', async () => {
|
||||
const validator = new SchemaValidator()
|
||||
|
||||
const validModel = {
|
||||
id: 'test-model',
|
||||
capabilities: ['FUNCTION_CALL', 'REASONING'],
|
||||
inputModalities: ['TEXT'],
|
||||
outputModalities: ['TEXT'],
|
||||
contextWindow: 128000,
|
||||
maxOutputTokens: 4096,
|
||||
metadata: {
|
||||
tags: ['test'],
|
||||
category: 'language-model',
|
||||
source: 'test'
|
||||
}
|
||||
}
|
||||
|
||||
const result = await validator.validateModel(validModel)
|
||||
expect(result.success).toBe(true)
|
||||
expect(result.data).toBeDefined()
|
||||
expect(result.data!.id).toBe('test-model')
|
||||
})
|
||||
|
||||
it('should reject invalid model configuration', async () => {
|
||||
const validator = new SchemaValidator()
|
||||
|
||||
const invalidModel = {
|
||||
id: 123, // Should be string
|
||||
capabilities: 'not-array', // Should be array
|
||||
contextWindow: -1000 // Should be positive
|
||||
}
|
||||
|
||||
const result = await validator.validateModel(invalidModel)
|
||||
expect(result.success).toBe(false)
|
||||
expect(result.errors).toBeDefined()
|
||||
expect(result.errors!.length).toBeGreaterThan(0)
|
||||
})
|
||||
|
||||
it('should provide warnings for model configuration issues', async () => {
|
||||
const validator = new SchemaValidator()
|
||||
|
||||
const modelWithIssues = {
|
||||
id: 'test-model',
|
||||
capabilities: [], // Empty capabilities
|
||||
inputModalities: ['TEXT'],
|
||||
outputModalities: ['TEXT'],
|
||||
contextWindow: 200000, // Large context window
|
||||
maxOutputTokens: 4096,
|
||||
// Missing pricing and description
|
||||
metadata: {
|
||||
tags: ['test'],
|
||||
category: 'language-model',
|
||||
source: 'test'
|
||||
}
|
||||
}
|
||||
|
||||
const result = await validator.validateModel(modelWithIssues)
|
||||
expect(result.success).toBe(true)
|
||||
expect(result.warnings).toBeDefined()
|
||||
expect(result.warnings!.length).toBeGreaterThan(0)
|
||||
})
|
||||
|
||||
it('should accept custom validation warnings', async () => {
|
||||
const validator = new SchemaValidator()
|
||||
|
||||
const model = {
|
||||
id: 'test-model',
|
||||
capabilities: ['FUNCTION_CALL'],
|
||||
inputModalities: ['TEXT'],
|
||||
outputModalities: ['TEXT'],
|
||||
contextWindow: 1000,
|
||||
maxOutputTokens: 500,
|
||||
metadata: {
|
||||
tags: ['test'],
|
||||
category: 'language-model',
|
||||
source: 'test'
|
||||
}
|
||||
}
|
||||
|
||||
const result = await validator.validateModel(model, {
|
||||
includeWarnings: true,
|
||||
customValidation: () => ['Custom warning message']
|
||||
})
|
||||
|
||||
expect(result.success).toBe(true)
|
||||
expect(result.warnings).toContain('Custom warning message')
|
||||
})
|
||||
})
|
||||
|
||||
describe('Integration Tests', () => {
|
||||
it('should load and validate models end-to-end', async () => {
|
||||
const loader = new ConfigLoader({
|
||||
basePath: fixturesPath,
|
||||
validateOnLoad: true,
|
||||
cacheEnabled: false
|
||||
})
|
||||
|
||||
const validator = new SchemaValidator()
|
||||
|
||||
// Load models
|
||||
const models = await loader.loadModels('test-models.json')
|
||||
expect(models.length).toBeGreaterThan(0)
|
||||
|
||||
// Validate first model
|
||||
const validationResult = await validator.validateModel(models[0])
|
||||
expect(validationResult.success).toBe(true)
|
||||
expect(validationResult.data).toBeDefined()
|
||||
expect(validationResult.data!.id).toBe(models[0].id)
|
||||
})
|
||||
|
||||
it('should work with caching enabled', async () => {
|
||||
const loader = new ConfigLoader({
|
||||
basePath: fixturesPath,
|
||||
validateOnLoad: true,
|
||||
cacheEnabled: true
|
||||
})
|
||||
|
||||
// Test that caching doesn't break basic functionality
|
||||
const models1 = await loader.loadModels('test-models.json')
|
||||
expect(models1.length).toBeGreaterThan(0)
|
||||
expect(models1[0]).toHaveProperty('id', 'test-model')
|
||||
|
||||
// Test cache clear functionality
|
||||
loader.clearCache()
|
||||
expect(true).toBe(true) // Cache clear should not throw
|
||||
})
|
||||
})
|
||||
|
||||
describe('Snapshot Tests', () => {
|
||||
it('should snapshot model configurations', async () => {
|
||||
const loader = new ConfigLoader({
|
||||
basePath: fixturesPath,
|
||||
validateOnLoad: true,
|
||||
cacheEnabled: false
|
||||
})
|
||||
|
||||
const models = await loader.loadModels('test-models.json')
|
||||
expect(models).toMatchSnapshot()
|
||||
})
|
||||
|
||||
it('should snapshot provider configurations', async () => {
|
||||
const loader = new ConfigLoader({
|
||||
basePath: fixturesPath,
|
||||
validateOnLoad: true,
|
||||
cacheEnabled: false
|
||||
})
|
||||
|
||||
const providers = await loader.loadProviders('test-providers.json')
|
||||
expect(providers).toMatchSnapshot()
|
||||
})
|
||||
|
||||
it('should snapshot override configurations', async () => {
|
||||
const loader = new ConfigLoader({
|
||||
basePath: fixturesPath,
|
||||
validateOnLoad: true,
|
||||
cacheEnabled: false
|
||||
})
|
||||
|
||||
const overrides = await loader.loadOverrides('test-overrides.json')
|
||||
expect(overrides).toMatchSnapshot()
|
||||
})
|
||||
|
||||
it('should snapshot complete configuration structure', async () => {
|
||||
const loader = new ConfigLoader({
|
||||
basePath: fixturesPath,
|
||||
validateOnLoad: true,
|
||||
cacheEnabled: false
|
||||
})
|
||||
|
||||
const configs = await loader.loadAllConfigs({
|
||||
modelsFile: 'test-models.json',
|
||||
providersFile: 'test-providers.json',
|
||||
overridesFile: 'test-overrides.json'
|
||||
})
|
||||
|
||||
expect(configs).toMatchSnapshot({
|
||||
models: expect.any(Array),
|
||||
providers: expect.any(Array),
|
||||
overrides: expect.any(Array)
|
||||
})
|
||||
})
|
||||
|
||||
it('should snapshot validation results', async () => {
|
||||
const loader = new ConfigLoader({
|
||||
basePath: fixturesPath,
|
||||
validateOnLoad: true,
|
||||
cacheEnabled: false
|
||||
})
|
||||
const validator = new SchemaValidator()
|
||||
|
||||
const model = await loader.loadModels('test-models.json')
|
||||
const validationResult = await validator.validateModel(model[0], {
|
||||
includeWarnings: true,
|
||||
customValidation: () => ['Custom validation warning for snapshot']
|
||||
})
|
||||
|
||||
expect(validationResult).toMatchSnapshot()
|
||||
})
|
||||
})
|
||||
})
|
||||
54
packages/catalog/src/__tests__/fixtures/test-models.json
Normal file
54
packages/catalog/src/__tests__/fixtures/test-models.json
Normal file
@@ -0,0 +1,54 @@
|
||||
{
|
||||
"version": "1.0.0",
|
||||
"models": [
|
||||
{
|
||||
"id": "test-model",
|
||||
"name": "Test Model",
|
||||
"ownedBy": "TestProvider",
|
||||
"description": "A test model for unit testing",
|
||||
"capabilities": ["FUNCTION_CALL", "REASONING"],
|
||||
"inputModalities": ["TEXT"],
|
||||
"outputModalities": ["TEXT"],
|
||||
"contextWindow": 128000,
|
||||
"maxOutputTokens": 4096,
|
||||
"maxInputTokens": 124000,
|
||||
"pricing": {
|
||||
"input": {
|
||||
"perMillionTokens": 1,
|
||||
"currency": "USD"
|
||||
},
|
||||
"output": {
|
||||
"perMillionTokens": 2,
|
||||
"currency": "USD"
|
||||
}
|
||||
},
|
||||
"parameters": {
|
||||
"temperature": {
|
||||
"supported": true,
|
||||
"min": 0,
|
||||
"max": 2,
|
||||
"default": 1
|
||||
},
|
||||
"maxTokens": true,
|
||||
"systemMessage": true,
|
||||
"topP": {
|
||||
"supported": true,
|
||||
"min": 0,
|
||||
"max": 1,
|
||||
"default": 1
|
||||
}
|
||||
},
|
||||
"endpointTypes": ["CHAT_COMPLETIONS"],
|
||||
"metadata": {
|
||||
"tags": ["test", "fast", "reliable"],
|
||||
"category": "language-model",
|
||||
"source": "test",
|
||||
"license": "mit",
|
||||
"documentation": "https://docs.test.com/models/test-model",
|
||||
"family": "test-family",
|
||||
"architecture": "transformer",
|
||||
"trainingData": "synthetic"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
28
packages/catalog/src/__tests__/fixtures/test-overrides.json
Normal file
28
packages/catalog/src/__tests__/fixtures/test-overrides.json
Normal file
@@ -0,0 +1,28 @@
|
||||
{
|
||||
"version": "1.0.0",
|
||||
"overrides": [
|
||||
{
|
||||
"providerId": "test-provider",
|
||||
"modelId": "test-model",
|
||||
"capabilities": {
|
||||
"add": ["FUNCTION_CALL"],
|
||||
"remove": ["REASONING"]
|
||||
},
|
||||
"limits": {
|
||||
"contextWindow": 256000,
|
||||
"maxOutputTokens": 8192
|
||||
},
|
||||
"pricing": {
|
||||
"input": {
|
||||
"perMillionTokens": 0.5,
|
||||
"currency": "USD"
|
||||
}
|
||||
},
|
||||
"disabled": false,
|
||||
"reason": "Test override for enhanced capabilities and limits",
|
||||
"lastUpdated": "2025-11-24T07:08:00Z",
|
||||
"updatedBy": "test-suite",
|
||||
"priority": 100
|
||||
}
|
||||
]
|
||||
}
|
||||
53
packages/catalog/src/__tests__/fixtures/test-providers.json
Normal file
53
packages/catalog/src/__tests__/fixtures/test-providers.json
Normal file
@@ -0,0 +1,53 @@
|
||||
{
|
||||
"version": "1.0.0",
|
||||
"providers": [
|
||||
{
|
||||
"id": "test-provider",
|
||||
"name": "Test Provider",
|
||||
"description": "A test provider for unit testing",
|
||||
"authentication": "API_KEY",
|
||||
"pricingModel": "PER_MODEL",
|
||||
"modelRouting": "DIRECT",
|
||||
"behaviors": {
|
||||
"supportsCustomModels": false,
|
||||
"providesModelMapping": false,
|
||||
"supportsModelVersioning": false,
|
||||
"providesFallbackRouting": false,
|
||||
"hasAutoRetry": false,
|
||||
"supportsHealthCheck": false,
|
||||
"hasRealTimeMetrics": false,
|
||||
"providesUsageAnalytics": false,
|
||||
"supportsWebhookEvents": false,
|
||||
"requiresApiKeyValidation": true,
|
||||
"supportsRateLimiting": false,
|
||||
"providesUsageLimits": false,
|
||||
"supportsStreaming": true,
|
||||
"supportsBatchProcessing": false,
|
||||
"supportsModelFineTuning": false
|
||||
},
|
||||
"supportedEndpoints": ["CHAT_COMPLETIONS"],
|
||||
"apiCompatibility": {
|
||||
"supportsArrayContent": true,
|
||||
"supportsStreamOptions": false,
|
||||
"supportsDeveloperRole": false,
|
||||
"supportsThinkingControl": false,
|
||||
"supportsApiVersion": false,
|
||||
"supportsParallelTools": false,
|
||||
"supportsMultimodal": false
|
||||
},
|
||||
"specialConfig": {},
|
||||
"documentation": "https://docs.test.com",
|
||||
"website": "https://test.com",
|
||||
"deprecated": false,
|
||||
"maintenanceMode": false,
|
||||
"configVersion": "1.0.0",
|
||||
"metadata": {
|
||||
"tags": ["test"],
|
||||
"category": "ai-provider",
|
||||
"source": "test",
|
||||
"reliability": "high",
|
||||
"supportedLanguages": ["en"]
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
21
packages/catalog/src/index.ts
Normal file
21
packages/catalog/src/index.ts
Normal file
@@ -0,0 +1,21 @@
|
||||
/**
|
||||
* Cherry Studio Catalog
|
||||
* Main entry point for the model and provider catalog system
|
||||
*/
|
||||
|
||||
// Export all schemas
|
||||
export * from './schemas'
|
||||
|
||||
// Export core functionality
|
||||
export type {
|
||||
ConfigLoadOptions,
|
||||
ModelConfig,
|
||||
ProviderConfig,
|
||||
ProviderModelOverride
|
||||
} from './loader/ConfigLoader'
|
||||
export { ConfigLoader } from './loader/ConfigLoader'
|
||||
export type {
|
||||
ValidationOptions,
|
||||
ValidationResult
|
||||
} from './validator/SchemaValidator'
|
||||
export { SchemaValidator } from './validator/SchemaValidator'
|
||||
244
packages/catalog/src/loader/ConfigLoader.ts
Normal file
244
packages/catalog/src/loader/ConfigLoader.ts
Normal file
@@ -0,0 +1,244 @@
|
||||
/**
|
||||
* Configuration Loader
|
||||
* Responsible for loading and parsing JSON configuration files
|
||||
*/
|
||||
|
||||
import * as fs from 'fs/promises'
|
||||
import * as path from 'path'
|
||||
import type * as z from 'zod'
|
||||
|
||||
import { ModelListSchema, OverrideListSchema, ProviderListSchema } from '../schemas'
|
||||
import { safeParseJSON } from '../utils/parse-json/parse-json'
|
||||
import { zod4Schema } from '../utils/schema'
|
||||
|
||||
export type ModelConfig = z.infer<typeof ModelListSchema>['models'][0]
|
||||
export type ProviderConfig = z.infer<typeof ProviderListSchema>['providers'][0]
|
||||
export type ProviderModelOverride = z.infer<typeof OverrideListSchema>['overrides'][0]
|
||||
|
||||
export interface ConfigLoadOptions {
|
||||
basePath?: string
|
||||
validateOnLoad?: boolean
|
||||
cacheEnabled?: boolean
|
||||
}
|
||||
|
||||
export class ConfigLoader {
|
||||
private cache = new Map<string, any>()
|
||||
private options: ConfigLoadOptions
|
||||
|
||||
constructor(options: ConfigLoadOptions = {}) {
|
||||
this.options = {
|
||||
basePath: path.join(__dirname, '../data'),
|
||||
validateOnLoad: true,
|
||||
cacheEnabled: true,
|
||||
...options
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Load model configurations from JSON file
|
||||
*/
|
||||
async loadModels(filename = 'models.json'): Promise<ModelConfig[]> {
|
||||
const filePath = path.join(this.options.basePath!, filename)
|
||||
|
||||
if (this.options.cacheEnabled && this.cache.has(filePath)) {
|
||||
return this.cache.get(filePath)
|
||||
}
|
||||
|
||||
try {
|
||||
const rawData = await fs.readFile(filePath, 'utf-8')
|
||||
|
||||
let validatedData: any
|
||||
if (this.options.validateOnLoad) {
|
||||
const schema = zod4Schema(ModelListSchema)
|
||||
const parseResult = await safeParseJSON({ text: rawData, schema })
|
||||
|
||||
if (!parseResult.success) {
|
||||
throw new Error(`Validation failed: ${parseResult.error.message}`)
|
||||
}
|
||||
validatedData = parseResult.value
|
||||
} else {
|
||||
const parseResult = await safeParseJSON({ text: rawData })
|
||||
|
||||
if (!parseResult.success) {
|
||||
throw new Error(`Parse failed: ${parseResult.error.message}`)
|
||||
}
|
||||
validatedData = parseResult.value
|
||||
}
|
||||
|
||||
const models = validatedData.models
|
||||
const version = validatedData.version
|
||||
|
||||
if (this.options.cacheEnabled) {
|
||||
this.cache.set(filePath, { models, version })
|
||||
}
|
||||
|
||||
return models
|
||||
} catch (error) {
|
||||
throw new Error(
|
||||
`Failed to load models from ${filePath}: ${error instanceof Error ? error.message : 'Unknown error'}`
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Load provider configurations from JSON file
|
||||
*/
|
||||
async loadProviders(filename = 'providers.json'): Promise<ProviderConfig[]> {
|
||||
const filePath = path.join(this.options.basePath!, filename)
|
||||
|
||||
if (this.options.cacheEnabled && this.cache.has(filePath)) {
|
||||
return this.cache.get(filePath)
|
||||
}
|
||||
|
||||
try {
|
||||
const rawData = await fs.readFile(filePath, 'utf-8')
|
||||
let validatedData: any
|
||||
if (this.options.validateOnLoad) {
|
||||
const schema = zod4Schema(ProviderListSchema)
|
||||
const parseResult = await safeParseJSON({ text: rawData, schema })
|
||||
|
||||
if (!parseResult.success) {
|
||||
throw new Error(`Validation failed: ${parseResult.error.message}`)
|
||||
}
|
||||
validatedData = parseResult.value
|
||||
} else {
|
||||
const parseResult = await safeParseJSON({ text: rawData })
|
||||
|
||||
if (!parseResult.success) {
|
||||
throw new Error(`Parse failed: ${parseResult.error.message}`)
|
||||
}
|
||||
validatedData = parseResult.value
|
||||
}
|
||||
|
||||
const providers = validatedData.providers
|
||||
const version = validatedData.version
|
||||
|
||||
if (this.options.cacheEnabled) {
|
||||
this.cache.set(filePath, { providers, version })
|
||||
}
|
||||
|
||||
return providers
|
||||
} catch (error) {
|
||||
throw new Error(
|
||||
`Failed to load providers from ${filePath}: ${error instanceof Error ? error.message : 'Unknown error'}`
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Load override configurations from JSON file
|
||||
*/
|
||||
async loadOverrides(filename = 'overrides.json'): Promise<ProviderModelOverride[]> {
|
||||
const filePath = path.join(this.options.basePath!, filename)
|
||||
|
||||
if (this.options.cacheEnabled && this.cache.has(filePath)) {
|
||||
return this.cache.get(filePath)
|
||||
}
|
||||
|
||||
try {
|
||||
const rawData = await fs.readFile(filePath, 'utf-8')
|
||||
let validatedData: any
|
||||
if (this.options.validateOnLoad) {
|
||||
const schema = zod4Schema(OverrideListSchema)
|
||||
const parseResult = await safeParseJSON({ text: rawData, schema })
|
||||
|
||||
if (!parseResult.success) {
|
||||
throw new Error(`Validation failed: ${parseResult.error.message}`)
|
||||
}
|
||||
validatedData = parseResult.value
|
||||
} else {
|
||||
const parseResult = await safeParseJSON({ text: rawData })
|
||||
|
||||
if (!parseResult.success) {
|
||||
throw new Error(`Parse failed: ${parseResult.error.message}`)
|
||||
}
|
||||
validatedData = parseResult.value
|
||||
}
|
||||
|
||||
const overrides = validatedData.overrides
|
||||
const version = validatedData.version
|
||||
|
||||
if (this.options.cacheEnabled) {
|
||||
this.cache.set(filePath, { overrides, version })
|
||||
}
|
||||
|
||||
return overrides
|
||||
} catch (error) {
|
||||
throw new Error(
|
||||
`Failed to load overrides from ${filePath}: ${error instanceof Error ? error.message : 'Unknown error'}`
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Load all configuration files
|
||||
*/
|
||||
async loadAllConfigs(options: { modelsFile?: string; providersFile?: string; overridesFile?: string } = {}): Promise<{
|
||||
models: ModelConfig[]
|
||||
providers: ProviderConfig[]
|
||||
overrides: ProviderModelOverride[]
|
||||
}> {
|
||||
const [models, providers, overrides] = await Promise.all([
|
||||
this.loadModels(options.modelsFile),
|
||||
this.loadProviders(options.providersFile),
|
||||
this.loadOverrides(options.overridesFile)
|
||||
])
|
||||
|
||||
return { models, providers, overrides }
|
||||
}
|
||||
|
||||
/**
|
||||
* Clear cache
|
||||
*/
|
||||
clearCache(): void {
|
||||
this.cache.clear()
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if file exists
|
||||
*/
|
||||
private async fileExists(filePath: string): Promise<boolean> {
|
||||
try {
|
||||
await fs.access(filePath)
|
||||
return true
|
||||
} catch {
|
||||
return false
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get configuration file version
|
||||
*/
|
||||
async getConfigVersion(filename: string): Promise<string | null> {
|
||||
const filePath = path.join(this.options.basePath!, filename)
|
||||
|
||||
if (!(await this.fileExists(filePath))) {
|
||||
return null
|
||||
}
|
||||
|
||||
try {
|
||||
const rawData = await fs.readFile(filePath, 'utf-8')
|
||||
const jsonData = JSON.parse(rawData)
|
||||
return jsonData.version || null
|
||||
} catch {
|
||||
return null
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get all configuration versions
|
||||
*/
|
||||
async getAllConfigVersions(): Promise<{
|
||||
models: string | null
|
||||
providers: string | null
|
||||
overrides: string | null
|
||||
}> {
|
||||
const [models, providers, overrides] = await Promise.all([
|
||||
this.getConfigVersion('models.json'),
|
||||
this.getConfigVersion('providers.json'),
|
||||
this.getConfigVersion('overrides.json')
|
||||
])
|
||||
|
||||
return { models, providers, overrides }
|
||||
}
|
||||
}
|
||||
69
packages/catalog/src/schemas/common.ts
Normal file
69
packages/catalog/src/schemas/common.ts
Normal file
@@ -0,0 +1,69 @@
|
||||
/**
|
||||
* Common type definitions for the catalog system
|
||||
* Shared across model, provider, and override schemas
|
||||
*/
|
||||
|
||||
import * as z from 'zod'
|
||||
|
||||
// Common string types for reuse
|
||||
export const ModelIdSchema = z.string()
|
||||
export const ProviderIdSchema = z.string()
|
||||
export const VersionSchema = z.string()
|
||||
|
||||
// Currency codes
|
||||
export const CurrencySchema = z.enum(['USD', 'EUR', 'CNY', 'JPY', 'GBP'])
|
||||
|
||||
// Common file size units
|
||||
export const FileSizeUnitSchema = z.enum(['B', 'KB', 'MB', 'GB'])
|
||||
|
||||
// Common status types
|
||||
export const StatusSchema = z.enum(['active', 'inactive', 'deprecated', 'maintenance'])
|
||||
|
||||
// Timestamp schema for date fields
|
||||
export const TimestampSchema = z.iso.datetime()
|
||||
|
||||
// Range helper schemas
|
||||
export const NumericRangeSchema = z.object({
|
||||
min: z.number(),
|
||||
max: z.number()
|
||||
})
|
||||
|
||||
export const StringRangeSchema = z.object({
|
||||
min: z.string(),
|
||||
max: z.string()
|
||||
})
|
||||
|
||||
// Price per token schema
|
||||
export const PricePerTokenSchema = z.object({
|
||||
perMillionTokens: z.number().nonnegative(),
|
||||
currency: CurrencySchema.default('USD')
|
||||
})
|
||||
|
||||
// Generic metadata schema
|
||||
export const MetadataSchema = z.record(z.string(), z.any()).optional()
|
||||
|
||||
// Type exports
|
||||
export type ModelId = z.infer<typeof ModelIdSchema>
|
||||
export type ProviderId = z.infer<typeof ProviderIdSchema>
|
||||
export type Version = z.infer<typeof VersionSchema>
|
||||
export type Currency = z.infer<typeof CurrencySchema>
|
||||
export type FileSizeUnit = z.infer<typeof FileSizeUnitSchema>
|
||||
export type Status = z.infer<typeof StatusSchema>
|
||||
export type Timestamp = z.infer<typeof TimestampSchema>
|
||||
export type NumericRange = z.infer<typeof NumericRangeSchema>
|
||||
export type StringRange = z.infer<typeof StringRangeSchema>
|
||||
export type PricePerToken = z.infer<typeof PricePerTokenSchema>
|
||||
export type Metadata = z.infer<typeof MetadataSchema>
|
||||
|
||||
// Common validation utilities
|
||||
export const validateRange = (min: number, max: number): boolean => {
|
||||
return min <= max
|
||||
}
|
||||
|
||||
export const validatePositiveNumber = (value: number): boolean => {
|
||||
return value >= 0
|
||||
}
|
||||
|
||||
export const validateNonEmptyString = (value: string): boolean => {
|
||||
return value.trim().length > 0
|
||||
}
|
||||
49
packages/catalog/src/schemas/index.ts
Normal file
49
packages/catalog/src/schemas/index.ts
Normal file
@@ -0,0 +1,49 @@
|
||||
/**
|
||||
* Unified export of all catalog schemas and types
|
||||
* This file provides a single entry point for all schema definitions
|
||||
*/
|
||||
|
||||
// Export all schemas from common types
|
||||
export * from './common'
|
||||
|
||||
// Export model schemas
|
||||
export * from './model'
|
||||
|
||||
// Export provider schemas
|
||||
export * from './provider'
|
||||
|
||||
// Export override schemas
|
||||
export * from './override'
|
||||
|
||||
// Re-export commonly used combined types for convenience
|
||||
export type {
|
||||
Modality,
|
||||
ModelCapabilityType,
|
||||
ModelConfig,
|
||||
ModelPricing,
|
||||
ParameterSupport,
|
||||
Reasoning
|
||||
} from './model'
|
||||
export type {
|
||||
OverrideResult,
|
||||
OverrideValidation,
|
||||
ProviderModelOverride
|
||||
} from './override'
|
||||
export type {
|
||||
Authentication,
|
||||
EndpointType,
|
||||
McpSupport,
|
||||
PricingModel,
|
||||
ProviderBehaviors,
|
||||
ProviderConfig
|
||||
} from './provider'
|
||||
|
||||
// Export common types
|
||||
export type {
|
||||
Currency,
|
||||
Metadata,
|
||||
ModelId,
|
||||
ProviderId,
|
||||
Timestamp,
|
||||
Version
|
||||
} from './common'
|
||||
254
packages/catalog/src/schemas/model.ts
Normal file
254
packages/catalog/src/schemas/model.ts
Normal file
@@ -0,0 +1,254 @@
|
||||
/**
|
||||
* Model configuration schema definitions
|
||||
* Defines the structure for model metadata, capabilities, and configurations
|
||||
*/
|
||||
|
||||
import * as z from 'zod'
|
||||
|
||||
import {
|
||||
CurrencySchema,
|
||||
MetadataSchema,
|
||||
ModelIdSchema,
|
||||
PricePerTokenSchema,
|
||||
TimestampSchema,
|
||||
VersionSchema
|
||||
} from './common'
|
||||
|
||||
// Modality types - supported input/output modalities
|
||||
export const ModalitySchema = z.enum(['TEXT', 'VISION', 'AUDIO', 'VIDEO', 'VECTOR'])
|
||||
|
||||
// Model capability types
|
||||
export const ModelCapabilityTypeSchema = z.enum([
|
||||
'FUNCTION_CALL', // Function calling
|
||||
'REASONING', // Reasoning/thinking
|
||||
'IMAGE_RECOGNITION', // Image recognition
|
||||
'IMAGE_GENERATION', // Image generation
|
||||
'AUDIO_RECOGNITION', // Audio recognition
|
||||
'AUDIO_GENERATION', // Audio generation
|
||||
'EMBEDDING', // Embedding vector generation
|
||||
'RERANK', // Text reranking
|
||||
'AUDIO_TRANSCRIPT', // Audio transcription
|
||||
'VIDEO_RECOGNITION', // Video recognition
|
||||
'VIDEO_GENERATION', // Video generation
|
||||
'STRUCTURED_OUTPUT', // Structured output
|
||||
'FILE_INPUT', // File input support
|
||||
'WEB_SEARCH', // Built-in web search
|
||||
'CODE_EXECUTION', // Code execution
|
||||
'FILE_SEARCH', // File search
|
||||
'COMPUTER_USE' // Computer use
|
||||
])
|
||||
|
||||
// Reasoning configuration
|
||||
export const ReasoningSchema = z.discriminatedUnion('type', [
|
||||
z.object({
|
||||
type: z.literal('openai-chat'),
|
||||
params: z.object({
|
||||
reasoning_effort: z.enum(['none', 'minimal', 'low', 'medium', 'high']).optional()
|
||||
})
|
||||
}),
|
||||
z.object({
|
||||
type: z.literal('openai-responses'),
|
||||
params: z.object({
|
||||
reasoning: z.object({
|
||||
effort: z.enum(['none', 'minimal', 'low', 'medium', 'high']).optional(),
|
||||
summary: z.enum(['auto', 'concise', 'detailed']).optional()
|
||||
})
|
||||
})
|
||||
}),
|
||||
z.object({
|
||||
type: z.literal('anthropic'),
|
||||
params: z.object({
|
||||
type: z.union([z.literal('enabled'), z.literal('disabled')]),
|
||||
budgetTokens: z.number().optional()
|
||||
})
|
||||
}),
|
||||
z.object({
|
||||
type: z.literal('gemini'),
|
||||
params: z.union([
|
||||
z
|
||||
.object({
|
||||
thinking_config: z.object({
|
||||
include_thoughts: z.boolean().optional(),
|
||||
thinking_budget: z.number().optional()
|
||||
})
|
||||
})
|
||||
.optional(),
|
||||
z
|
||||
.object({
|
||||
thinking_level: z.enum(['low', 'medium', 'high']).optional()
|
||||
})
|
||||
.optional()
|
||||
])
|
||||
}),
|
||||
z.object({
|
||||
type: z.literal('openrouter'),
|
||||
params: z.object({
|
||||
reasoning: z
|
||||
.object({
|
||||
effort: z
|
||||
.union([z.literal('none'), z.literal('minimal'), z.literal('low'), z.literal('medium'), z.literal('high')])
|
||||
.optional(),
|
||||
max_tokens: z.number().optional(),
|
||||
exclude: z.boolean().optional()
|
||||
})
|
||||
.refine((v) => {
|
||||
v.effort == null || v.max_tokens == null
|
||||
}, 'One of the following (not both)')
|
||||
})
|
||||
}),
|
||||
z.object({
|
||||
type: z.literal('qwen'),
|
||||
params: z.object({
|
||||
enable_thinking: z.boolean(),
|
||||
thinking_budget: z.number().optional()
|
||||
})
|
||||
}),
|
||||
z.object({
|
||||
type: z.literal('doubao'),
|
||||
params: z.object({
|
||||
thinking: z.object({
|
||||
type: z.union([z.literal('enabled'), z.literal('disabled'), z.literal('auto')])
|
||||
})
|
||||
})
|
||||
}),
|
||||
z.object({
|
||||
type: z.literal('dashscope'),
|
||||
params: z.object({
|
||||
enable_thinking: z.boolean(),
|
||||
incremental_output: z.boolean().optional()
|
||||
})
|
||||
}),
|
||||
z.object({
|
||||
type: z.literal('self-hosted'),
|
||||
params: z.object({
|
||||
chat_template_kwargs: z.object({
|
||||
enable_thinking: z.boolean().optional(),
|
||||
thinking: z.boolean().optional()
|
||||
})
|
||||
})
|
||||
})
|
||||
])
|
||||
|
||||
// Parameter support configuration
|
||||
export const ParameterSupportSchema = z.object({
|
||||
temperature: z
|
||||
.object({
|
||||
supported: z.boolean(),
|
||||
min: z.number().min(0).max(2).optional(),
|
||||
max: z.number().min(0).max(2).optional(),
|
||||
default: z.number().min(0).max(2).optional()
|
||||
})
|
||||
.optional(),
|
||||
|
||||
topP: z
|
||||
.object({
|
||||
supported: z.boolean(),
|
||||
min: z.number().min(0).max(1).optional(),
|
||||
max: z.number().min(0).max(1).optional(),
|
||||
default: z.number().min(0).max(1).optional()
|
||||
})
|
||||
.optional(),
|
||||
|
||||
topK: z
|
||||
.object({
|
||||
supported: z.boolean(),
|
||||
min: z.number().positive().optional(),
|
||||
max: z.number().positive().optional()
|
||||
})
|
||||
.optional(),
|
||||
|
||||
frequencyPenalty: z.boolean().optional(),
|
||||
presencePenalty: z.boolean().optional(),
|
||||
maxTokens: z.boolean().optional(),
|
||||
stopSequences: z.boolean().optional(),
|
||||
systemMessage: z.boolean().optional(),
|
||||
developerRole: z.boolean().optional()
|
||||
})
|
||||
|
||||
// Model pricing configuration
|
||||
export const ModelPricingSchema = z.object({
|
||||
input: PricePerTokenSchema,
|
||||
output: PricePerTokenSchema,
|
||||
|
||||
// Image pricing (optional)
|
||||
per_image: z
|
||||
.object({
|
||||
price: z.number(),
|
||||
currency: CurrencySchema.default('USD'),
|
||||
unit: z.enum(['image', 'pixel']).optional()
|
||||
})
|
||||
.optional(),
|
||||
|
||||
// Audio/video pricing (optional)
|
||||
per_minute: z
|
||||
.object({
|
||||
price: z.number(),
|
||||
currency: CurrencySchema.default('USD')
|
||||
})
|
||||
.optional()
|
||||
})
|
||||
|
||||
// Model configuration schema
|
||||
export const ModelConfigSchema = z.object({
|
||||
// Basic information
|
||||
id: ModelIdSchema,
|
||||
name: z.string().optional(),
|
||||
owned_by: z.string().optional(),
|
||||
description: z.string().optional(),
|
||||
|
||||
// Capabilities (core)
|
||||
capabilities: z.array(ModelCapabilityTypeSchema),
|
||||
|
||||
// Modalities
|
||||
input_modalities: z.array(ModalitySchema),
|
||||
output_modalities: z.array(ModalitySchema),
|
||||
|
||||
// Limits
|
||||
context_window: z.number(),
|
||||
max_output_tokens: z.number(),
|
||||
max_input_tokens: z.number().optional(),
|
||||
|
||||
// Pricing
|
||||
pricing: ModelPricingSchema.optional(),
|
||||
|
||||
// Reasoning configuration
|
||||
reasoning: ReasoningSchema.optional(),
|
||||
|
||||
// Parameter support
|
||||
parameters: ParameterSupportSchema.optional(),
|
||||
|
||||
// Endpoint types (will reference provider schema)
|
||||
endpoint_types: z.array(z.string()).optional(),
|
||||
|
||||
// Metadata
|
||||
release_date: TimestampSchema.optional(),
|
||||
deprecation_date: TimestampSchema.optional(),
|
||||
replaced_by: ModelIdSchema.optional(),
|
||||
|
||||
// Version control
|
||||
version: VersionSchema.optional(),
|
||||
compatibility: z
|
||||
.object({
|
||||
min_version: VersionSchema.optional(),
|
||||
max_version: VersionSchema.optional()
|
||||
})
|
||||
.optional(),
|
||||
|
||||
// Additional metadata
|
||||
metadata: MetadataSchema
|
||||
})
|
||||
|
||||
// Model list container schema for JSON files
|
||||
export const ModelListSchema = z.object({
|
||||
version: VersionSchema,
|
||||
models: z.array(ModelConfigSchema)
|
||||
})
|
||||
|
||||
// Type exports
|
||||
export type Modality = z.infer<typeof ModalitySchema>
|
||||
export type ModelCapabilityType = z.infer<typeof ModelCapabilityTypeSchema>
|
||||
export type Reasoning = z.infer<typeof ReasoningSchema>
|
||||
export type ParameterSupport = z.infer<typeof ParameterSupportSchema>
|
||||
export type ModelPricing = z.infer<typeof ModelPricingSchema>
|
||||
export type ModelConfig = z.infer<typeof ModelConfigSchema>
|
||||
export type ModelList = z.infer<typeof ModelListSchema>
|
||||
147
packages/catalog/src/schemas/override.ts
Normal file
147
packages/catalog/src/schemas/override.ts
Normal file
@@ -0,0 +1,147 @@
|
||||
/**
|
||||
* Provider model override schema definitions
|
||||
* Defines how providers can override specific model configurations
|
||||
*/
|
||||
|
||||
import * as z from 'zod'
|
||||
|
||||
import { MetadataSchema, ModelIdSchema, ProviderIdSchema, VersionSchema } from './common'
|
||||
import { ModelCapabilityTypeSchema, ModelPricingSchema, ParameterSupportSchema, ReasoningSchema } from './model'
|
||||
import { EndpointTypeSchema } from './provider'
|
||||
|
||||
// Capability override operations
|
||||
export const CapabilityOverrideSchema = z.object({
|
||||
add: z.array(ModelCapabilityTypeSchema).optional(), // Add capabilities
|
||||
remove: z.array(ModelCapabilityTypeSchema).optional(), // Remove capabilities
|
||||
force: z.array(ModelCapabilityTypeSchema).optional() // Force set capabilities (ignore base config)
|
||||
})
|
||||
|
||||
// Limits override configuration
|
||||
export const LimitsOverrideSchema = z.object({
|
||||
context_window: z.number().optional(),
|
||||
max_output_tokens: z.number().optional(),
|
||||
max_input_tokens: z.number().optional()
|
||||
})
|
||||
|
||||
// Pricing override configuration
|
||||
export const PricingOverrideSchema = ModelPricingSchema.partial().optional()
|
||||
|
||||
// Endpoint types override
|
||||
export const EndpointTypesOverrideSchema = z.array(EndpointTypeSchema).optional()
|
||||
|
||||
// Reasoning configuration override - allows partial override of reasoning configs
|
||||
export const ReasoningOverrideSchema = ReasoningSchema.optional()
|
||||
|
||||
// Parameter support override
|
||||
export const ParameterSupportOverrideSchema = ParameterSupportSchema.partial().optional()
|
||||
|
||||
// Model metadata override
|
||||
export const MetadataOverrideSchema = z
|
||||
.object({
|
||||
name: z.string().optional(),
|
||||
description: z.string().optional(),
|
||||
deprecation_date: z.iso.datetime().optional(),
|
||||
replaced_by: ModelIdSchema.optional(),
|
||||
metadata: MetadataSchema
|
||||
})
|
||||
.optional()
|
||||
|
||||
// Main provider model override schema
|
||||
export const ProviderModelOverrideSchema = z.object({
|
||||
// Identification
|
||||
provider_id: ProviderIdSchema,
|
||||
model_id: ModelIdSchema,
|
||||
|
||||
// Capability overrides
|
||||
capabilities: CapabilityOverrideSchema.optional(),
|
||||
|
||||
// Limits overrides
|
||||
limits: LimitsOverrideSchema.optional(),
|
||||
|
||||
// Pricing overrides
|
||||
pricing: PricingOverrideSchema,
|
||||
|
||||
// Reasoning configuration overrides
|
||||
reasoning: ReasoningOverrideSchema.optional(),
|
||||
|
||||
// Parameter support overrides
|
||||
parameters: ParameterSupportOverrideSchema.optional(),
|
||||
|
||||
// Endpoint type overrides
|
||||
endpoint_types: EndpointTypesOverrideSchema.optional(),
|
||||
|
||||
// Model metadata overrides
|
||||
metadata: MetadataOverrideSchema.optional(),
|
||||
|
||||
// Status overrides
|
||||
disabled: z.boolean().optional(), // Disable this model for this provider
|
||||
replace_with: ModelIdSchema.optional(), // Replace with alternative model
|
||||
|
||||
// Override tracking
|
||||
reason: z.string().optional(), // Reason for override
|
||||
last_updated: z.iso.datetime().optional(),
|
||||
updated_by: z.string().optional(), // Who made the override
|
||||
|
||||
// Override priority (higher number = higher priority)
|
||||
priority: z.number().default(0),
|
||||
|
||||
// Override conditions
|
||||
conditions: z
|
||||
.object({
|
||||
// Apply override only for specific regions
|
||||
regions: z.array(z.string()).optional(),
|
||||
|
||||
// Apply override only for specific user tiers
|
||||
user_tiers: z.array(z.string()).optional(),
|
||||
|
||||
// Apply override only in specific environments
|
||||
environments: z.array(z.enum(['development', 'staging', 'production'])).optional(),
|
||||
|
||||
// Time-based conditions
|
||||
valid_from: z.iso.datetime().optional(),
|
||||
valid_until: z.iso.datetime().optional()
|
||||
})
|
||||
.optional(),
|
||||
|
||||
// Additional override metadata
|
||||
override_metadata: MetadataSchema.optional()
|
||||
})
|
||||
|
||||
// Override container schema for JSON files
|
||||
export const OverrideListSchema = z.object({
|
||||
version: VersionSchema,
|
||||
overrides: z.array(ProviderModelOverrideSchema)
|
||||
})
|
||||
|
||||
// Override application result schema
|
||||
export const OverrideResultSchema = z.object({
|
||||
model_id: ModelIdSchema,
|
||||
provider_id: ProviderIdSchema,
|
||||
applied: z.boolean(),
|
||||
applied_overrides: z.array(z.string()), // List of applied override fields
|
||||
original_values: z.record(z.string(), z.unknown()), // Original values before override
|
||||
new_values: z.record(z.string(), z.unknown()), // New values after override
|
||||
override_reason: z.string().optional(),
|
||||
applied_at: z.iso.datetime().optional()
|
||||
})
|
||||
|
||||
// Override validation result
|
||||
export const OverrideValidationSchema = z.object({
|
||||
valid: z.boolean(),
|
||||
errors: z.array(z.string()),
|
||||
warnings: z.array(z.string()),
|
||||
recommendations: z.array(z.string())
|
||||
})
|
||||
|
||||
// Type exports
|
||||
export type CapabilityOverride = z.infer<typeof CapabilityOverrideSchema>
|
||||
export type LimitsOverride = z.infer<typeof LimitsOverrideSchema>
|
||||
export type PricingOverride = z.infer<typeof PricingOverrideSchema>
|
||||
export type EndpointTypesOverride = z.infer<typeof EndpointTypesOverrideSchema>
|
||||
export type ReasoningOverride = z.infer<typeof ReasoningOverrideSchema>
|
||||
export type ParameterSupportOverride = z.infer<typeof ParameterSupportOverrideSchema>
|
||||
export type MetadataOverride = z.infer<typeof MetadataOverrideSchema>
|
||||
export type ProviderModelOverride = z.infer<typeof ProviderModelOverrideSchema>
|
||||
export type OverrideList = z.infer<typeof OverrideListSchema>
|
||||
export type OverrideResult = z.infer<typeof OverrideResultSchema>
|
||||
export type OverrideValidation = z.infer<typeof OverrideValidationSchema>
|
||||
171
packages/catalog/src/schemas/provider.ts
Normal file
171
packages/catalog/src/schemas/provider.ts
Normal file
@@ -0,0 +1,171 @@
|
||||
/**
|
||||
* Provider configuration schema definitions
|
||||
* Defines the structure for AI service provider metadata and capabilities
|
||||
*/
|
||||
|
||||
import * as z from 'zod'
|
||||
|
||||
import { MetadataSchema, ProviderIdSchema, VersionSchema } from './common'
|
||||
|
||||
// Endpoint types supported by providers
|
||||
export const EndpointTypeSchema = z.enum([
|
||||
'CHAT_COMPLETIONS', // /chat/completions
|
||||
'COMPLETIONS', // /completions
|
||||
'EMBEDDINGS', // /embeddings
|
||||
'IMAGE_GENERATION', // /images/generations
|
||||
'IMAGE_EDIT', // /images/edits
|
||||
'AUDIO_SPEECH', // /audio/speech (TTS)
|
||||
'AUDIO_TRANSCRIPTIONS', // /audio/transcriptions (STT)
|
||||
'MESSAGES', // /messages
|
||||
'RESPONSES', // /responses
|
||||
'GENERATE_CONTENT', // :generateContent
|
||||
'STREAM_GENERATE_CONTENT', // :streamGenerateContent
|
||||
'RERANK', // /rerank
|
||||
'MODERATIONS' // /moderations
|
||||
])
|
||||
|
||||
// Authentication methods
|
||||
export const AuthenticationSchema = z.enum([
|
||||
'API_KEY', // Standard API Key authentication
|
||||
'OAUTH', // OAuth 2.0 authentication
|
||||
'CLOUD_CREDENTIALS' // Cloud service credentials (AWS, GCP, Azure)
|
||||
])
|
||||
|
||||
// Pricing models that affect UI and behavior
|
||||
export const PricingModelSchema = z.enum([
|
||||
'UNIFIED', // Unified pricing (like OpenRouter)
|
||||
'PER_MODEL', // Per-model independent pricing (like OpenAI official)
|
||||
'TRANSPARENT', // Transparent pricing (like New-API)
|
||||
'USAGE_BASED', // Dynamic usage-based pricing
|
||||
'SUBSCRIPTION' // Subscription-based pricing
|
||||
])
|
||||
|
||||
// Model routing strategies affecting performance and reliability
|
||||
export const ModelRoutingSchema = z.enum([
|
||||
'INTELLIGENT', // Intelligent routing, auto-select optimal instance
|
||||
'DIRECT', // Direct routing to specified model
|
||||
'LOAD_BALANCED', // Load balanced across multiple instances
|
||||
'GEO_ROUTED', // Geographic location routing
|
||||
'COST_OPTIMIZED' // Cost-optimized routing
|
||||
])
|
||||
|
||||
// Server-side MCP support configuration
|
||||
export const McpSupportSchema = z.object({
|
||||
supported: z.boolean().default(false),
|
||||
configuration: z
|
||||
.object({
|
||||
supports_url_pass_through: z.boolean().default(false),
|
||||
supported_servers: z.array(z.string()).optional(),
|
||||
max_concurrent_servers: z.number().optional()
|
||||
})
|
||||
.optional()
|
||||
})
|
||||
|
||||
// API compatibility configuration
|
||||
export const ApiCompatibilitySchema = z.object({
|
||||
supports_array_content: z.boolean().default(true),
|
||||
supports_stream_options: z.boolean().default(true),
|
||||
supports_developer_role: z.boolean().default(false),
|
||||
supports_service_tier: z.boolean().default(false),
|
||||
supports_thinking_control: z.boolean().default(false),
|
||||
supports_api_version: z.boolean().default(false),
|
||||
supports_parallel_tools: z.boolean().default(false),
|
||||
supports_multimodal: z.boolean().default(false),
|
||||
max_file_upload_size: z.number().optional(), // bytes
|
||||
supported_file_types: z.array(z.string()).optional()
|
||||
})
|
||||
|
||||
// Behavior characteristics configuration - replaces categorization, describes actual behavior
|
||||
export const ProviderBehaviorsSchema = z.object({
|
||||
// Model management
|
||||
supports_custom_models: z.boolean().default(false), // Supports user custom models
|
||||
provides_model_mapping: z.boolean().default(false), // Provides model name mapping
|
||||
supports_model_versioning: z.boolean().default(false), // Supports model version control
|
||||
|
||||
// Reliability and fault tolerance
|
||||
provides_fallback_routing: z.boolean().default(false), // Provides fallback routing
|
||||
has_auto_retry: z.boolean().default(false), // Has automatic retry mechanism
|
||||
supports_health_check: z.boolean().default(false), // Supports health checks
|
||||
|
||||
// Monitoring and metrics
|
||||
has_real_time_metrics: z.boolean().default(false), // Has real-time metrics
|
||||
provides_usage_analytics: z.boolean().default(false), // Provides usage analytics
|
||||
supports_webhook_events: z.boolean().default(false), // Supports webhook events
|
||||
|
||||
// Configuration and management
|
||||
requires_api_key_validation: z.boolean().default(true), // Requires API key validation
|
||||
supports_rate_limiting: z.boolean().default(false), // Supports rate limiting
|
||||
provides_usage_limits: z.boolean().default(false), // Provides usage limit configuration
|
||||
|
||||
// Advanced features
|
||||
supports_streaming: z.boolean().default(true), // Supports streaming responses
|
||||
supports_batch_processing: z.boolean().default(false), // Supports batch processing
|
||||
supports_model_fine_tuning: z.boolean().default(false) // Provides model fine-tuning
|
||||
})
|
||||
|
||||
// Provider configuration schema
|
||||
export const ProviderConfigSchema = z.object({
|
||||
// Basic information
|
||||
id: ProviderIdSchema,
|
||||
name: z.string(),
|
||||
description: z.string().optional(),
|
||||
|
||||
// Behavior-related configuration
|
||||
authentication: AuthenticationSchema,
|
||||
pricing_model: PricingModelSchema,
|
||||
model_routing: ModelRoutingSchema,
|
||||
behaviors: ProviderBehaviorsSchema,
|
||||
|
||||
// Feature support
|
||||
supported_endpoints: z.array(EndpointTypeSchema),
|
||||
mcp_support: McpSupportSchema.optional(),
|
||||
api_compatibility: ApiCompatibilitySchema.optional(),
|
||||
|
||||
// Default configuration
|
||||
default_api_host: z.string().optional(),
|
||||
default_rate_limit: z.number().optional(), // requests per minute
|
||||
|
||||
// Model matching assistance
|
||||
model_id_patterns: z.array(z.string()).optional(),
|
||||
alias_model_ids: z.record(z.string(), z.string()).optional(), // Model alias mapping
|
||||
|
||||
// Special configuration
|
||||
special_config: MetadataSchema,
|
||||
|
||||
// Metadata and links
|
||||
documentation: z.string().url().optional(),
|
||||
status_page: z.string().url().optional(),
|
||||
pricing_page: z.string().url().optional(),
|
||||
support_email: z.string().email().optional(),
|
||||
website: z.string().url().optional(),
|
||||
|
||||
// Status management
|
||||
deprecated: z.boolean().default(false),
|
||||
deprecation_date: z.iso.datetime().optional(),
|
||||
maintenance_mode: z.boolean().default(false),
|
||||
|
||||
// Version and compatibility
|
||||
min_app_version: VersionSchema.optional(), // Minimum supported app version
|
||||
max_app_version: VersionSchema.optional(), // Maximum supported app version
|
||||
config_version: VersionSchema.default('1.0.0'), // Configuration file version
|
||||
|
||||
// Additional metadata
|
||||
metadata: MetadataSchema
|
||||
})
|
||||
|
||||
// Provider list container schema for JSON files
|
||||
export const ProviderListSchema = z.object({
|
||||
version: VersionSchema,
|
||||
providers: z.array(ProviderConfigSchema)
|
||||
})
|
||||
|
||||
// Type exports
|
||||
export type EndpointType = z.infer<typeof EndpointTypeSchema>
|
||||
export type Authentication = z.infer<typeof AuthenticationSchema>
|
||||
export type PricingModel = z.infer<typeof PricingModelSchema>
|
||||
export type ModelRouting = z.infer<typeof ModelRoutingSchema>
|
||||
export type McpSupport = z.infer<typeof McpSupportSchema>
|
||||
export type ApiCompatibility = z.infer<typeof ApiCompatibilitySchema>
|
||||
export type ProviderBehaviors = z.infer<typeof ProviderBehaviorsSchema>
|
||||
export type ProviderConfig = z.infer<typeof ProviderConfigSchema>
|
||||
export type ProviderList = z.infer<typeof ProviderListSchema>
|
||||
2
packages/catalog/src/utils/json-value/index.ts
Normal file
2
packages/catalog/src/utils/json-value/index.ts
Normal file
@@ -0,0 +1,2 @@
|
||||
export { isJSONArray, isJSONObject, isJSONValue } from './is-json'
|
||||
export type { JSONArray, JSONObject, JSONValue } from './json-value'
|
||||
32
packages/catalog/src/utils/json-value/is-json.ts
Normal file
32
packages/catalog/src/utils/json-value/is-json.ts
Normal file
@@ -0,0 +1,32 @@
|
||||
// https://github.com/vercel/ai/blob/4c44a5bea002ef0db0e1b86a1e223cd9f4837d62/packages/provider/src/json-value/is-json.ts
|
||||
import type { JSONArray, JSONObject, JSONValue } from './json-value'
|
||||
|
||||
export function isJSONValue(value: unknown): value is JSONValue {
|
||||
if (value === null || typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean') {
|
||||
return true
|
||||
}
|
||||
|
||||
if (Array.isArray(value)) {
|
||||
return value.every(isJSONValue)
|
||||
}
|
||||
|
||||
if (typeof value === 'object') {
|
||||
return Object.entries(value).every(
|
||||
([key, val]) => typeof key === 'string' && (val === undefined || isJSONValue(val))
|
||||
)
|
||||
}
|
||||
|
||||
return false
|
||||
}
|
||||
|
||||
export function isJSONArray(value: unknown): value is JSONArray {
|
||||
return Array.isArray(value) && value.every(isJSONValue)
|
||||
}
|
||||
|
||||
export function isJSONObject(value: unknown): value is JSONObject {
|
||||
return (
|
||||
value != null &&
|
||||
typeof value === 'object' &&
|
||||
Object.entries(value).every(([key, val]) => typeof key === 'string' && (val === undefined || isJSONValue(val)))
|
||||
)
|
||||
}
|
||||
13
packages/catalog/src/utils/json-value/json-value.ts
Normal file
13
packages/catalog/src/utils/json-value/json-value.ts
Normal file
@@ -0,0 +1,13 @@
|
||||
// https://github.com/vercel/ai/blob/4c44a5bea002ef0db0e1b86a1e223cd9f4837d62/packages/provider/src/json-value/json-value.ts
|
||||
|
||||
/**
|
||||
A JSON value can be a string, number, boolean, object, array, or null.
|
||||
JSON values can be serialized and deserialized by the JSON.stringify and JSON.parse methods.
|
||||
*/
|
||||
export type JSONValue = null | string | number | boolean | JSONObject | JSONArray
|
||||
|
||||
export type JSONObject = {
|
||||
[key: string]: JSONValue | undefined
|
||||
}
|
||||
|
||||
export type JSONArray = JSONValue[]
|
||||
543
packages/catalog/src/utils/migration.ts
Normal file
543
packages/catalog/src/utils/migration.ts
Normal file
@@ -0,0 +1,543 @@
|
||||
/**
|
||||
* Migration Tool - Phase 2 Implementation
|
||||
* Migrates existing JSON data to new schema-based catalog system
|
||||
*/
|
||||
|
||||
import * as fs from 'fs/promises'
|
||||
import * as path from 'path'
|
||||
|
||||
interface ProviderEndpointsData {
|
||||
providers: Record<
|
||||
string,
|
||||
{
|
||||
display_name: string
|
||||
endpoints: Record<string, boolean>
|
||||
url: string
|
||||
}
|
||||
>
|
||||
}
|
||||
|
||||
interface ModelPricesData {
|
||||
[modelId: string]: {
|
||||
litellm_provider: string
|
||||
mode: string
|
||||
input_cost_per_token?: number
|
||||
output_cost_per_token?: number
|
||||
input_cost_per_pixel?: number
|
||||
output_cost_per_pixel?: number
|
||||
output_cost_per_image?: number
|
||||
max_input_tokens?: number
|
||||
max_output_tokens?: number
|
||||
max_tokens?: number
|
||||
supports_function_calling?: boolean
|
||||
supports_vision?: boolean
|
||||
supports_parallel_function_calling?: boolean
|
||||
supports_response_schema?: boolean
|
||||
supports_tool_choice?: boolean
|
||||
supports_system_messages?: boolean
|
||||
supports_assistant_prefill?: boolean
|
||||
supports_pdf_input?: boolean
|
||||
supports_prompt_caching?: boolean
|
||||
cache_creation_input_token_cost?: number
|
||||
cache_read_input_token_cost?: number
|
||||
metadata?: {
|
||||
notes?: string
|
||||
}
|
||||
source?: string
|
||||
supported_endpoints?: string[]
|
||||
deprecation_date?: string
|
||||
}
|
||||
}
|
||||
|
||||
interface ModelConfig {
|
||||
id: string
|
||||
name?: string
|
||||
owned_by?: string
|
||||
description?: string
|
||||
capabilities: string[]
|
||||
input_modalities: string[]
|
||||
output_modalities: string[]
|
||||
context_window: number
|
||||
max_output_tokens: number
|
||||
max_input_tokens?: number
|
||||
pricing?: {
|
||||
input: { per_million_tokens: number; currency: string }
|
||||
output: { per_million_tokens: number; currency: string }
|
||||
}
|
||||
parameters?: Record<string, any>
|
||||
endpoint_types?: string[]
|
||||
metadata?: Record<string, any>
|
||||
}
|
||||
|
||||
interface ProviderConfig {
|
||||
id: string
|
||||
name: string
|
||||
description?: string
|
||||
authentication: string
|
||||
supported_endpoints: string[]
|
||||
api_compatibility?: Record<string, boolean>
|
||||
special_config?: Record<string, any>
|
||||
documentation?: string
|
||||
website?: string
|
||||
deprecated: boolean
|
||||
maintenance_mode: boolean
|
||||
config_version: string
|
||||
metadata?: Record<string, any>
|
||||
}
|
||||
|
||||
interface OverrideConfig {
|
||||
provider_id: string
|
||||
model_id: string
|
||||
capabilities?: {
|
||||
add?: string[]
|
||||
remove?: string[]
|
||||
force?: string[]
|
||||
}
|
||||
limits?: {
|
||||
context_window?: number
|
||||
max_output_tokens?: number
|
||||
max_input_tokens?: number
|
||||
}
|
||||
pricing?: {
|
||||
input: { per_million_tokens: number; currency: string }
|
||||
output: { per_million_tokens: number; currency: string }
|
||||
}
|
||||
disabled?: boolean
|
||||
reason?: string
|
||||
last_updated?: string
|
||||
updated_by?: string
|
||||
priority?: number
|
||||
}
|
||||
|
||||
export class MigrationTool {
|
||||
private providerEndpointsData: ProviderEndpointsData
|
||||
private modelPricesData: ModelPricesData
|
||||
|
||||
constructor(
|
||||
private providerEndpointsPath: string,
|
||||
private modelPricesPath: string,
|
||||
private outputDir: string
|
||||
) {
|
||||
// Initialize with empty objects to satisfy TypeScript
|
||||
this.providerEndpointsData = { providers: {} }
|
||||
this.modelPricesData = {}
|
||||
}
|
||||
|
||||
async loadData(): Promise<void> {
|
||||
console.log('📖 Loading existing data...')
|
||||
|
||||
const providerEndpointsContent = await fs.readFile(this.providerEndpointsPath, 'utf-8')
|
||||
this.providerEndpointsData = JSON.parse(providerEndpointsContent)
|
||||
|
||||
const modelPricesContent = await fs.readFile(this.modelPricesPath, 'utf-8')
|
||||
this.modelPricesData = JSON.parse(modelPricesContent)
|
||||
|
||||
console.log(`✅ Loaded ${Object.keys(this.providerEndpointsData.providers).length} providers`)
|
||||
console.log(`✅ Loaded ${Object.keys(this.modelPricesData).length} model configurations`)
|
||||
}
|
||||
|
||||
/**
|
||||
* Extract base model identifier from provider-specific model ID
|
||||
*/
|
||||
private extractBaseModelId(providerModelId: string): string {
|
||||
// Remove provider prefixes
|
||||
const prefixes = [
|
||||
'azure/',
|
||||
'bedrock/',
|
||||
'openrouter/',
|
||||
'vertex_ai/',
|
||||
'sagemaker/',
|
||||
'watsonx/',
|
||||
'litellm_proxy/',
|
||||
'custom/',
|
||||
'aiml/',
|
||||
'together_ai/',
|
||||
'deepinfra/',
|
||||
'hyperbolic/',
|
||||
'fireworks_ai/',
|
||||
'replicate/',
|
||||
'novita/',
|
||||
'anyscale/',
|
||||
'runpod/',
|
||||
'triton/',
|
||||
'vllm/',
|
||||
'ollama/',
|
||||
'lm_studio/'
|
||||
]
|
||||
|
||||
let baseId = providerModelId
|
||||
for (const prefix of prefixes) {
|
||||
if (baseId.startsWith(prefix)) {
|
||||
baseId = baseId.substring(prefix.length)
|
||||
break
|
||||
}
|
||||
}
|
||||
|
||||
// Handle AWS Bedrock specific naming
|
||||
if (baseId.includes(':')) {
|
||||
baseId = baseId.split(':')[0]
|
||||
}
|
||||
|
||||
// Handle version suffixes
|
||||
baseId = baseId.replace(/\/v\d+$/, '').replace(/:v\d+$/, '')
|
||||
|
||||
return baseId
|
||||
}
|
||||
|
||||
/**
|
||||
* Determine if a model is a base model or provider-specific override
|
||||
*/
|
||||
private isBaseModel(modelId: string, provider: string): boolean {
|
||||
const baseId = this.extractBaseModelId(modelId)
|
||||
|
||||
// Official provider models are base models
|
||||
const officialProviders = [
|
||||
'anthropic',
|
||||
'openai',
|
||||
'gemini',
|
||||
'deepseek',
|
||||
'dashscope',
|
||||
'volceengine',
|
||||
'minimax',
|
||||
'moonshotai',
|
||||
'zai',
|
||||
'meta',
|
||||
'mistral',
|
||||
'cohere',
|
||||
'xai'
|
||||
]
|
||||
|
||||
if (officialProviders.includes(provider)) {
|
||||
return modelId === baseId || modelId.startsWith(provider + '/')
|
||||
}
|
||||
|
||||
// Third-party providers selling access to official models are overrides
|
||||
return false
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert endpoint support to provider capabilities
|
||||
*/
|
||||
private privateConvertEndpointsToCapabilities(endpoints: Record<string, boolean>): string[] {
|
||||
const endpointCapabilityMap: Record<string, string> = {
|
||||
chat_completions: 'CHAT_COMPLETIONS',
|
||||
messages: 'MESSAGES',
|
||||
responses: 'RESPONSES',
|
||||
completions: 'COMPLETIONS',
|
||||
embeddings: 'EMBEDDINGS',
|
||||
image_generations: 'IMAGE_GENERATION',
|
||||
image_edit: 'IMAGE_EDIT',
|
||||
audio_speech: 'AUDIO_GENERATION',
|
||||
audio_transcriptions: 'AUDIO_TRANSCRIPT',
|
||||
rerank: 'RERANK',
|
||||
moderations: 'MODERATIONS',
|
||||
ocr: 'OCR',
|
||||
search: 'WEB_SEARCH'
|
||||
}
|
||||
|
||||
const capabilities: string[] = []
|
||||
for (const [endpoint, supported] of Object.entries(endpoints)) {
|
||||
if (supported && endpointCapabilityMap[endpoint]) {
|
||||
capabilities.push(endpointCapabilityMap[endpoint])
|
||||
}
|
||||
}
|
||||
|
||||
return capabilities
|
||||
}
|
||||
|
||||
/**
|
||||
* Generate provider configurations
|
||||
*/
|
||||
private generateProviderConfigs(): ProviderConfig[] {
|
||||
const providers: ProviderConfig[] = []
|
||||
|
||||
for (const [providerId, providerData] of Object.entries(this.providerEndpointsData.providers)) {
|
||||
const supported_endpoints = this.privateConvertEndpointsToCapabilities(providerData.endpoints)
|
||||
|
||||
const provider: ProviderConfig = {
|
||||
id: providerId,
|
||||
name: providerData.display_name,
|
||||
description: `Provider: ${providerData.display_name}`,
|
||||
authentication: 'API_KEY',
|
||||
supported_endpoints,
|
||||
api_compatibility: {
|
||||
supports_array_content: providerData.endpoints.chat_completions || false,
|
||||
supports_stream_options: providerData.endpoints.chat_completions || false,
|
||||
supports_developer_role: providerId === 'openai',
|
||||
supports_service_tier: providerId === 'openai',
|
||||
supports_thinking_control: false,
|
||||
supports_api_version: providerId === 'openai',
|
||||
supports_parallel_tools: providerData.endpoints.chat_completions || false,
|
||||
supports_multimodal: providerData.endpoints.chat_completions || false
|
||||
},
|
||||
special_config: {},
|
||||
documentation: providerData.url,
|
||||
website: providerData.url,
|
||||
deprecated: false,
|
||||
maintenance_mode: false,
|
||||
config_version: '1.0.0'
|
||||
}
|
||||
|
||||
providers.push(provider)
|
||||
}
|
||||
|
||||
return providers
|
||||
}
|
||||
|
||||
/**
|
||||
* Generate base model configurations
|
||||
*/
|
||||
private generateBaseModels(): ModelConfig[] {
|
||||
const baseModels = new Map<string, ModelConfig>()
|
||||
|
||||
for (const [modelId, modelData] of Object.entries(this.modelPricesData)) {
|
||||
if (modelData.mode !== 'chat') continue // Skip non-chat models for now
|
||||
|
||||
const baseId = this.extractBaseModelId(modelId)
|
||||
const isBase = this.isBaseModel(modelId, modelData.litellm_provider)
|
||||
|
||||
if (!isBase) continue // Only process base models
|
||||
|
||||
// Extract capabilities from model data
|
||||
const capabilities: string[] = []
|
||||
if (modelData.supports_function_calling) capabilities.push('FUNCTION_CALL')
|
||||
if (modelData.supports_vision) capabilities.push('IMAGE_RECOGNITION')
|
||||
if (modelData.supports_response_schema) capabilities.push('STRUCTURED_OUTPUT')
|
||||
if (modelData.supports_pdf_input) capabilities.push('FILE_INPUT')
|
||||
if (modelData.supports_tool_choice) capabilities.push('FUNCTION_CALL')
|
||||
|
||||
// Determine modalities
|
||||
const input_modalities = ['TEXT']
|
||||
const output_modalities = ['TEXT']
|
||||
if (modelData.supports_vision) {
|
||||
input_modalities.push('VISION')
|
||||
}
|
||||
|
||||
// Convert pricing
|
||||
let pricing
|
||||
if (modelData.input_cost_per_token && modelData.output_cost_per_token) {
|
||||
pricing = {
|
||||
input: {
|
||||
per_million_tokens: Math.round(modelData.input_cost_per_token * 1000000 * 1000) / 1000,
|
||||
currency: 'USD'
|
||||
},
|
||||
output: {
|
||||
per_million_tokens: Math.round(modelData.output_cost_per_token * 1000000 * 1000) / 1000,
|
||||
currency: 'USD'
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
const baseModel: ModelConfig = {
|
||||
id: baseId,
|
||||
name: baseId,
|
||||
owned_by: modelData.litellm_provider,
|
||||
capabilities,
|
||||
input_modalities,
|
||||
output_modalities,
|
||||
context_window: modelData.max_input_tokens || 4096,
|
||||
max_output_tokens: modelData.max_output_tokens || modelData.max_tokens || 2048,
|
||||
max_input_tokens: modelData.max_input_tokens,
|
||||
pricing,
|
||||
parameters: {
|
||||
temperature: { supported: true, min: 0, max: 1, default: 1 },
|
||||
max_tokens: true,
|
||||
system_message: modelData.supports_system_messages || false,
|
||||
top_p: { supported: false }
|
||||
},
|
||||
endpoint_types: ['CHAT_COMPLETIONS'],
|
||||
metadata: {
|
||||
source: 'migration',
|
||||
original_provider: modelData.litellm_provider,
|
||||
supports_caching: !!modelData.supports_prompt_caching
|
||||
}
|
||||
}
|
||||
|
||||
baseModels.set(baseId, baseModel)
|
||||
}
|
||||
|
||||
return Array.from(baseModels.values())
|
||||
}
|
||||
|
||||
/**
|
||||
* Generate override configurations
|
||||
*/
|
||||
private generateOverrides(): OverrideConfig[] {
|
||||
const overrides: OverrideConfig[] = []
|
||||
|
||||
for (const [modelId, modelData] of Object.entries(this.modelPricesData)) {
|
||||
if (modelData.mode !== 'chat') continue
|
||||
|
||||
const baseId = this.extractBaseModelId(modelId)
|
||||
const isBase = this.isBaseModel(modelId, modelData.litellm_provider)
|
||||
|
||||
if (isBase) continue // Only generate overrides for non-base models
|
||||
|
||||
const override: OverrideConfig = {
|
||||
provider_id: modelData.litellm_provider,
|
||||
model_id: baseId,
|
||||
disabled: false,
|
||||
reason: `Provider-specific implementation of ${baseId}`,
|
||||
last_updated: new Date().toISOString().split('T')[0],
|
||||
updated_by: 'migration-tool',
|
||||
priority: 100
|
||||
}
|
||||
|
||||
// Add capability differences
|
||||
const capabilities = modelData.supports_function_calling ? ['FUNCTION_CALL'] : []
|
||||
if (modelData.supports_vision) capabilities.push('IMAGE_RECOGNITION')
|
||||
|
||||
if (capabilities.length > 0) {
|
||||
override.capabilities = { add: capabilities }
|
||||
}
|
||||
|
||||
// Add limit differences
|
||||
const limits: any = {}
|
||||
if (modelData.max_input_tokens && modelData.max_input_tokens !== 128000) {
|
||||
limits.context_window = modelData.max_input_tokens
|
||||
}
|
||||
if (modelData.max_output_tokens && modelData.max_output_tokens !== 4096) {
|
||||
limits.max_output_tokens = modelData.max_output_tokens
|
||||
}
|
||||
|
||||
if (Object.keys(limits).length > 0) {
|
||||
override.limits = limits
|
||||
}
|
||||
|
||||
// Add pricing differences
|
||||
if (modelData.input_cost_per_token && modelData.output_cost_per_token) {
|
||||
override.pricing = {
|
||||
input: {
|
||||
per_million_tokens: Math.round(modelData.input_cost_per_token * 1000000 * 1000) / 1000,
|
||||
currency: 'USD'
|
||||
},
|
||||
output: {
|
||||
per_million_tokens: Math.round(modelData.output_cost_per_token * 1000000 * 1000) / 1000,
|
||||
currency: 'USD'
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
overrides.push(override)
|
||||
}
|
||||
|
||||
return overrides
|
||||
}
|
||||
|
||||
/**
|
||||
* Execute the full migration
|
||||
*/
|
||||
async migrate(): Promise<void> {
|
||||
console.log('🚀 Starting Phase 2 Migration...')
|
||||
|
||||
await this.loadData()
|
||||
|
||||
// Create output directory
|
||||
await fs.mkdir(this.outputDir, { recursive: true })
|
||||
|
||||
// Generate configurations
|
||||
console.log('📦 Generating provider configurations...')
|
||||
const providers = this.generateProviderConfigs()
|
||||
|
||||
console.log('📦 Generating base model configurations...')
|
||||
const models = this.generateBaseModels()
|
||||
|
||||
console.log('📦 Generating override configurations...')
|
||||
const overrides = this.generateOverrides()
|
||||
|
||||
// Write single file for all providers
|
||||
console.log('💾 Writing providers.json...')
|
||||
await this.writeJsonFile('providers.json', {
|
||||
version: '2025.11.24',
|
||||
providers
|
||||
})
|
||||
|
||||
// Write single file for all models
|
||||
console.log('💾 Writing models.json...')
|
||||
await this.writeJsonFile('models.json', {
|
||||
version: '2025.11.24',
|
||||
models
|
||||
})
|
||||
|
||||
// Write single file for all overrides
|
||||
console.log('💾 Writing overrides.json...')
|
||||
await this.writeJsonFile('overrides.json', {
|
||||
version: '2025.11.24',
|
||||
overrides
|
||||
})
|
||||
|
||||
// Generate migration report
|
||||
const providersByType = {
|
||||
direct: providers.filter((p) => ['anthropic', 'openai', 'google'].includes(p.id)).length,
|
||||
cloud: providers.filter((p) => ['azure', 'bedrock', 'vertex_ai'].some((c) => p.id.includes(c))).length,
|
||||
proxy: providers.filter((p) => ['openrouter', 'litellm_proxy', 'together_ai'].some((c) => p.id.includes(c)))
|
||||
.length,
|
||||
self_hosted: providers.filter((p) => ['ollama', 'lm_studio', 'vllm'].some((c) => p.id.includes(c))).length
|
||||
}
|
||||
|
||||
const modelsByProvider = models.reduce(
|
||||
(acc, model) => {
|
||||
const provider = model.owned_by || 'unknown'
|
||||
acc[provider] = (acc[provider] || 0) + 1
|
||||
return acc
|
||||
},
|
||||
{} as Record<string, number>
|
||||
)
|
||||
|
||||
const overridesByProvider = overrides.reduce(
|
||||
(acc, override) => {
|
||||
acc[override.provider_id] = (acc[override.provider_id] || 0) + 1
|
||||
return acc
|
||||
},
|
||||
{} as Record<string, number>
|
||||
)
|
||||
|
||||
const report = {
|
||||
timestamp: new Date().toISOString(),
|
||||
summary: {
|
||||
total_providers: providers.length,
|
||||
total_base_models: models.length,
|
||||
total_overrides: overrides.length,
|
||||
provider_categories: providersByType,
|
||||
models_by_provider: modelsByProvider,
|
||||
overrides_by_provider: overridesByProvider
|
||||
},
|
||||
files: {
|
||||
providers: 'providers.json',
|
||||
models: 'models.json',
|
||||
overrides: 'overrides.json'
|
||||
}
|
||||
}
|
||||
|
||||
await this.writeJsonFile('migration-report.json', report)
|
||||
|
||||
console.log('\n✅ Migration completed successfully!')
|
||||
console.log(`📊 Migration Summary:`)
|
||||
console.log(
|
||||
` Providers: ${providers.length} (${providersByType.direct} direct, ${providersByType.cloud} cloud, ${providersByType.proxy} proxy, ${providersByType.self_hosted} self-hosted)`
|
||||
)
|
||||
console.log(` Base Models: ${models.length}`)
|
||||
console.log(` Overrides: ${overrides.length}`)
|
||||
console.log(`\n📁 Output Files:`)
|
||||
console.log(` ${this.outputDir}/providers.json`)
|
||||
console.log(` ${this.outputDir}/models.json`)
|
||||
console.log(` ${this.outputDir}/overrides.json`)
|
||||
console.log(` ${this.outputDir}/migration-report.json`)
|
||||
}
|
||||
|
||||
private async writeJsonFile(filename: string, data: any): Promise<void> {
|
||||
const filePath = path.join(this.outputDir, filename)
|
||||
await fs.writeFile(filePath, JSON.stringify(data, null, 2), 'utf-8')
|
||||
}
|
||||
}
|
||||
|
||||
// CLI execution
|
||||
if (require.main === module) {
|
||||
const tool = new MigrationTool(
|
||||
'./provider_endpoints_support.json',
|
||||
'./model_prices_and_context_window.json',
|
||||
'./migrated-data'
|
||||
)
|
||||
|
||||
tool.migrate().catch(console.error)
|
||||
}
|
||||
88
packages/catalog/src/utils/parse-json/parse-json.ts
Normal file
88
packages/catalog/src/utils/parse-json/parse-json.ts
Normal file
@@ -0,0 +1,88 @@
|
||||
// https://github.com/vercel/ai/blob/6306603220f9f023fcdbeb9768d1c3fc2ca6bc80/packages/provider-utils/src/parse-json.ts
|
||||
import type { JSONValue } from '../json-value'
|
||||
import type { Schema } from '../schema'
|
||||
import { safeValidateTypes, validateTypes } from '../validate-type'
|
||||
import { secureJsonParse } from './secure-json-parse'
|
||||
|
||||
/**
|
||||
* Parses a JSON string into an unknown object.
|
||||
*
|
||||
* @param text - The JSON string to parse.
|
||||
* @returns {JSONValue} - The parsed JSON object.
|
||||
*/
|
||||
export async function parseJSON(options: { text: string; schema?: undefined }): Promise<JSONValue>
|
||||
/**
|
||||
* Parses a JSON string into a strongly-typed object using the provided schema.
|
||||
*
|
||||
* @template T - The type of the object to parse the JSON into.
|
||||
* @param {string} text - The JSON string to parse.
|
||||
* @param {Validator<T>} schema - The schema to use for parsing the JSON.
|
||||
* @returns {Promise<T>} - The parsed object.
|
||||
*/
|
||||
export async function parseJSON<T>(options: { text: string; schema: Schema<T> }): Promise<T>
|
||||
export async function parseJSON<T>({ text, schema }: { text: string; schema?: Schema<T> }): Promise<T> {
|
||||
const value = secureJsonParse(text)
|
||||
|
||||
if (schema == null) {
|
||||
return value
|
||||
}
|
||||
|
||||
return validateTypes<T>({ value, schema })
|
||||
}
|
||||
|
||||
export type ParseResult<T> =
|
||||
| { success: true; value: T; rawValue: unknown }
|
||||
| {
|
||||
success: false
|
||||
error: Error
|
||||
rawValue: unknown
|
||||
}
|
||||
|
||||
/**
|
||||
* Safely parses a JSON string and returns the result as an object of type `unknown`.
|
||||
*
|
||||
* @param text - The JSON string to parse.
|
||||
* @returns {Promise<object>} Either an object with `success: true` and the parsed data, or an object with `success: false` and the error that occurred.
|
||||
*/
|
||||
export async function safeParseJSON(options: { text: string; schema?: undefined }): Promise<ParseResult<JSONValue>>
|
||||
/**
|
||||
* Safely parses a JSON string into a strongly-typed object, using a provided schema to validate the object.
|
||||
*
|
||||
* @template T - The type of the object to parse the JSON into.
|
||||
* @param {string} text - The JSON string to parse.
|
||||
* @param {Validator<T>} schema - The schema to use for parsing the JSON.
|
||||
* @returns An object with either a `success` flag and the parsed and typed data, or a `success` flag and an error object.
|
||||
*/
|
||||
export async function safeParseJSON<T>(options: { text: string; schema: Schema<T> }): Promise<ParseResult<T>>
|
||||
export async function safeParseJSON<T>({
|
||||
text,
|
||||
schema
|
||||
}: {
|
||||
text: string
|
||||
schema?: Schema<T>
|
||||
}): Promise<ParseResult<T>> {
|
||||
try {
|
||||
const value = secureJsonParse(text)
|
||||
|
||||
if (schema == null) {
|
||||
return { success: true, value: value as T, rawValue: value }
|
||||
}
|
||||
|
||||
return await safeValidateTypes<T>({ value, schema })
|
||||
} catch (error) {
|
||||
return {
|
||||
success: false,
|
||||
error: error instanceof Error ? error : new Error('Unknown parsing error'),
|
||||
rawValue: undefined
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export function isParsableJson(input: string): boolean {
|
||||
try {
|
||||
secureJsonParse(input)
|
||||
return true
|
||||
} catch {
|
||||
return false
|
||||
}
|
||||
}
|
||||
90
packages/catalog/src/utils/parse-json/secure-json-parse.ts
Normal file
90
packages/catalog/src/utils/parse-json/secure-json-parse.ts
Normal file
@@ -0,0 +1,90 @@
|
||||
// https://github.com/vercel/ai/blob/32d8dbbebdb7831467c702094cc903cf93ee15ef/packages/provider-utils/src/secure-json-parse.ts
|
||||
// Licensed under BSD-3-Clause (this file only)
|
||||
// Code adapted from https://github.com/fastify/secure-json-parse/blob/783fcb1b5434709466759847cec974381939673a/index.js
|
||||
//
|
||||
// Copyright (c) Vercel, Inc. (https://vercel.com)
|
||||
// Copyright (c) 2019 The Fastify Team
|
||||
// Copyright (c) 2019, Sideway Inc, and project contributors
|
||||
// All rights reserved.
|
||||
//
|
||||
// The complete list of contributors can be found at:
|
||||
// - https://github.com/hapijs/bourne/graphs/contributors
|
||||
// - https://github.com/fastify/secure-json-parse/graphs/contributors
|
||||
// - https://github.com/vercel/ai/commits/main/packages/provider-utils/src/secure-parse-json.ts
|
||||
//
|
||||
// Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
|
||||
//
|
||||
// 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
|
||||
//
|
||||
// 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
|
||||
//
|
||||
// 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
|
||||
//
|
||||
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
const suspectProtoRx = /"__proto__"\s*:/
|
||||
const suspectConstructorRx = /"constructor"\s*:/
|
||||
|
||||
function _parse(text: string) {
|
||||
// Parse normally
|
||||
const obj = JSON.parse(text)
|
||||
|
||||
// Ignore null and non-objects
|
||||
if (obj === null || typeof obj !== 'object') {
|
||||
return obj
|
||||
}
|
||||
|
||||
if (suspectProtoRx.test(text) === false && suspectConstructorRx.test(text) === false) {
|
||||
return obj
|
||||
}
|
||||
|
||||
// Scan result for proto keys
|
||||
return filter(obj)
|
||||
}
|
||||
|
||||
function filter(obj: any) {
|
||||
let next = [obj]
|
||||
|
||||
while (next.length) {
|
||||
const nodes = next
|
||||
next = []
|
||||
|
||||
for (const node of nodes) {
|
||||
if (Object.prototype.hasOwnProperty.call(node, '__proto__')) {
|
||||
throw new SyntaxError('Object contains forbidden prototype property')
|
||||
}
|
||||
|
||||
if (
|
||||
Object.prototype.hasOwnProperty.call(node, 'constructor') &&
|
||||
Object.prototype.hasOwnProperty.call(node.constructor, 'prototype')
|
||||
) {
|
||||
throw new SyntaxError('Object contains forbidden prototype property')
|
||||
}
|
||||
|
||||
for (const key in node) {
|
||||
const value = node[key]
|
||||
if (value && typeof value === 'object') {
|
||||
next.push(value)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
return obj
|
||||
}
|
||||
|
||||
export function secureJsonParse(text: string) {
|
||||
const { stackTraceLimit } = Error
|
||||
try {
|
||||
// Performance optimization, see https://github.com/fastify/secure-json-parse/pull/90
|
||||
Error.stackTraceLimit = 0
|
||||
} catch (e) {
|
||||
// Fallback in case Error is immutable (v8 readonly)
|
||||
return _parse(text)
|
||||
}
|
||||
|
||||
try {
|
||||
return _parse(text)
|
||||
} finally {
|
||||
Error.stackTraceLimit = stackTraceLimit
|
||||
}
|
||||
}
|
||||
92
packages/catalog/src/utils/schema.ts
Normal file
92
packages/catalog/src/utils/schema.ts
Normal file
@@ -0,0 +1,92 @@
|
||||
// https://github.com/vercel/ai/blob/6306603220f9f023fcdbeb9768d1c3fc2ca6bc80/packages/provider-utils/src/schema.ts
|
||||
import type { JSONSchema7 } from 'json-schema'
|
||||
import * as z4 from 'zod/v4'
|
||||
|
||||
export type ValidationResult<OBJECT> = { success: true; value: OBJECT } | { success: false; error: Error }
|
||||
|
||||
const schemaSymbol = Symbol.for('schema')
|
||||
|
||||
export type Schema<OBJECT = unknown> = {
|
||||
/**
|
||||
* Used to mark schemas so we can support both Zod and custom schemas.
|
||||
*/
|
||||
[schemaSymbol]: true
|
||||
|
||||
/**
|
||||
* Schema type for inference.
|
||||
*/
|
||||
_type: OBJECT
|
||||
|
||||
/**
|
||||
* Optional. Validates that the structure of a value matches this schema,
|
||||
* and returns a typed version of the value if it does.
|
||||
*/
|
||||
readonly validate?: (value: unknown) => ValidationResult<OBJECT> | PromiseLike<ValidationResult<OBJECT>>
|
||||
|
||||
/**
|
||||
* The JSON Schema for the schema.
|
||||
*/
|
||||
readonly jsonSchema: JSONSchema7 | PromiseLike<JSONSchema7>
|
||||
}
|
||||
|
||||
export function asSchema<OBJECT>(schema: Schema<OBJECT> | undefined): Schema<OBJECT> {
|
||||
return schema == null
|
||||
? jsonSchema({
|
||||
properties: {},
|
||||
additionalProperties: false
|
||||
})
|
||||
: schema
|
||||
}
|
||||
|
||||
export function jsonSchema<OBJECT = unknown>(
|
||||
jsonSchema: JSONSchema7 | PromiseLike<JSONSchema7> | (() => JSONSchema7 | PromiseLike<JSONSchema7>),
|
||||
{
|
||||
validate
|
||||
}: {
|
||||
validate?: (value: unknown) => ValidationResult<OBJECT> | PromiseLike<ValidationResult<OBJECT>>
|
||||
} = {}
|
||||
): Schema<OBJECT> {
|
||||
return {
|
||||
[schemaSymbol]: true,
|
||||
_type: undefined as OBJECT, // should never be used directly
|
||||
get jsonSchema() {
|
||||
if (typeof jsonSchema === 'function') {
|
||||
jsonSchema = jsonSchema() // cache the function results
|
||||
}
|
||||
return jsonSchema
|
||||
},
|
||||
validate
|
||||
}
|
||||
}
|
||||
|
||||
export function zod4Schema<OBJECT>(
|
||||
zodSchema: z4.core.$ZodType<OBJECT, any>,
|
||||
options?: {
|
||||
/**
|
||||
* Enables support for references in the schema.
|
||||
* This is required for recursive schemas, e.g. with `z.lazy`.
|
||||
* However, not all language models and providers support such references.
|
||||
* Defaults to `false`.
|
||||
*/
|
||||
useReferences?: boolean
|
||||
}
|
||||
): Schema<OBJECT> {
|
||||
// default to no references (to support openapi conversion for google)
|
||||
const useReferences = options?.useReferences ?? false
|
||||
|
||||
return jsonSchema(
|
||||
// defer json schema creation to avoid unnecessary computation when only validation is needed
|
||||
() =>
|
||||
z4.toJSONSchema(zodSchema, {
|
||||
target: 'draft-7',
|
||||
io: 'output',
|
||||
reused: useReferences ? 'ref' : 'inline'
|
||||
}) as JSONSchema7,
|
||||
{
|
||||
validate: async (value) => {
|
||||
const result = await z4.safeParseAsync(zodSchema, value)
|
||||
return result.success ? { success: true, value: result.data } : { success: false, error: result.error }
|
||||
}
|
||||
}
|
||||
)
|
||||
}
|
||||
75
packages/catalog/src/utils/validate-type.ts
Normal file
75
packages/catalog/src/utils/validate-type.ts
Normal file
@@ -0,0 +1,75 @@
|
||||
// https://github.com/vercel/ai/blob/6306603220f9f023fcdbeb9768d1c3fc2ca6bc80/packages/provider-utils/src/validate-types.ts
|
||||
import { asSchema, type Schema } from './schema'
|
||||
|
||||
/**
|
||||
* Validates the types of an unknown object using a schema and
|
||||
* return a strongly-typed object.
|
||||
*
|
||||
* @template T - The type of the object to validate.
|
||||
* @param {string} options.value - The object to validate.
|
||||
* @param {Validator<T>} options.schema - The schema to use for validating the JSON.
|
||||
* @returns {Promise<T>} - The typed object.
|
||||
*/
|
||||
export async function validateTypes<OBJECT>({
|
||||
value,
|
||||
schema
|
||||
}: {
|
||||
value: unknown
|
||||
schema: Schema<OBJECT>
|
||||
}): Promise<OBJECT> {
|
||||
const result = await safeValidateTypes({ value, schema })
|
||||
|
||||
if (!result.success) {
|
||||
throw Error(`Validation failed: ${result.error.message}`)
|
||||
}
|
||||
|
||||
return result.value
|
||||
}
|
||||
|
||||
/**
|
||||
* Safely validates the types of an unknown object using a schema and
|
||||
* return a strongly-typed object.
|
||||
*
|
||||
* @template T - The type of the object to validate.
|
||||
* @param {string} options.value - The JSON object to validate.
|
||||
* @param {Validator<T>} options.schema - The schema to use for validating the JSON.
|
||||
* @returns An object with either a `success` flag and the parsed and typed data, or a `success` flag and an error object.
|
||||
*/
|
||||
export async function safeValidateTypes<OBJECT>({ value, schema }: { value: unknown; schema: Schema<OBJECT> }): Promise<
|
||||
| {
|
||||
success: true
|
||||
value: OBJECT
|
||||
rawValue: unknown
|
||||
}
|
||||
| {
|
||||
success: false
|
||||
error: Error
|
||||
rawValue: unknown
|
||||
}
|
||||
> {
|
||||
const actualSchema = asSchema(schema)
|
||||
|
||||
try {
|
||||
if (actualSchema.validate == null) {
|
||||
return { success: true, value: value as OBJECT, rawValue: value }
|
||||
}
|
||||
|
||||
const result = await actualSchema.validate(value)
|
||||
|
||||
if (result.success) {
|
||||
return { success: true, value: result.value, rawValue: value }
|
||||
}
|
||||
|
||||
return {
|
||||
success: false,
|
||||
error: Error(`Validation failed: ${result.error.message}`),
|
||||
rawValue: value
|
||||
}
|
||||
} catch (error) {
|
||||
return {
|
||||
success: false,
|
||||
error: error instanceof Error ? error : new Error('Unknown validation error'),
|
||||
rawValue: value
|
||||
}
|
||||
}
|
||||
}
|
||||
299
packages/catalog/src/validator/SchemaValidator.ts
Normal file
299
packages/catalog/src/validator/SchemaValidator.ts
Normal file
@@ -0,0 +1,299 @@
|
||||
/**
|
||||
* Schema Validator
|
||||
* Provides validation functionality for all configuration schemas
|
||||
*/
|
||||
|
||||
import * as z from 'zod'
|
||||
|
||||
import { ModelConfigSchema, OverrideListSchema, ProviderConfigSchema } from '../schemas'
|
||||
import { zod4Schema } from '../utils/schema'
|
||||
import { safeValidateTypes } from '../utils/validate-type'
|
||||
|
||||
export type ModelConfig = z.infer<typeof ModelConfigSchema>
|
||||
export type ProviderConfig = z.infer<typeof ProviderConfigSchema>
|
||||
export type OverrideConfig = z.infer<typeof OverrideListSchema>
|
||||
|
||||
export interface ValidationResult<T = any> {
|
||||
success: boolean
|
||||
data?: T
|
||||
errors?: z.ZodIssue['path'] extends (string | number)[] ? z.ZodIssue : z.ZodIssue[]
|
||||
warnings?: string[]
|
||||
}
|
||||
|
||||
export interface ValidationOptions {
|
||||
strict?: boolean
|
||||
includeWarnings?: boolean
|
||||
customValidation?: (data: any) => string[]
|
||||
}
|
||||
|
||||
export class SchemaValidator {
|
||||
/**
|
||||
* Validate model configuration
|
||||
*/
|
||||
async validateModel(config: any, options: ValidationOptions = {}): Promise<ValidationResult<ModelConfig>> {
|
||||
const { includeWarnings = true, customValidation } = options
|
||||
|
||||
const schema = zod4Schema(ModelConfigSchema)
|
||||
|
||||
const validation = await safeValidateTypes({ value: config, schema })
|
||||
|
||||
if (!validation.success) {
|
||||
return {
|
||||
success: false,
|
||||
errors: [{ code: 'custom' as const, message: validation.error.message, path: [] }]
|
||||
}
|
||||
}
|
||||
|
||||
const model = validation.value
|
||||
|
||||
const warnings: string[] = []
|
||||
|
||||
// Basic warnings
|
||||
if (includeWarnings) {
|
||||
if (!model.pricing) {
|
||||
warnings.push('No pricing information provided')
|
||||
}
|
||||
|
||||
if (!model.description) {
|
||||
warnings.push('No model description provided')
|
||||
}
|
||||
|
||||
if (model.capabilities?.includes('REASONING') && !model.reasoning) {
|
||||
warnings.push('Model has REASONING capability but no reasoning configuration')
|
||||
}
|
||||
|
||||
if (model.contextWindow && model.contextWindow > 128000) {
|
||||
warnings.push('Large context window may impact performance')
|
||||
}
|
||||
|
||||
if (model.capabilities?.length === 0) {
|
||||
warnings.push('No capabilities specified for model')
|
||||
}
|
||||
}
|
||||
|
||||
// Custom validation warnings
|
||||
if (includeWarnings && customValidation) {
|
||||
warnings.push(...customValidation(config))
|
||||
}
|
||||
|
||||
return {
|
||||
success: true,
|
||||
data: model,
|
||||
warnings: warnings.length > 0 ? warnings : undefined
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Validate provider configuration
|
||||
*/
|
||||
validateProvider(config: any, options: ValidationOptions = {}): ValidationResult<ProviderConfig> {
|
||||
const { includeWarnings = true, customValidation } = options
|
||||
|
||||
try {
|
||||
const result = ProviderConfigSchema.parse(config)
|
||||
|
||||
const warnings: string[] = []
|
||||
|
||||
if (includeWarnings && customValidation) {
|
||||
warnings.push(...customValidation(config))
|
||||
}
|
||||
|
||||
if (includeWarnings) {
|
||||
if (!config.behaviors.requiresApiKeyValidation) {
|
||||
warnings.push('Provider does not require API key validation - ensure this is intentional')
|
||||
}
|
||||
|
||||
if (config.endpoints.length === 0) {
|
||||
warnings.push('No endpoints defined for provider')
|
||||
}
|
||||
|
||||
if (config.pricingModel === 'UNIFIED' && !config.behaviors.providesModelMapping) {
|
||||
warnings.push('Unified pricing model without model mapping may cause confusion')
|
||||
}
|
||||
}
|
||||
|
||||
return {
|
||||
success: true,
|
||||
data: result,
|
||||
warnings: warnings.length > 0 ? warnings : undefined
|
||||
}
|
||||
} catch (error) {
|
||||
if (error instanceof z.ZodError) {
|
||||
return {
|
||||
success: false,
|
||||
errors: error.issues
|
||||
}
|
||||
}
|
||||
|
||||
return {
|
||||
success: false,
|
||||
errors: [{ code: 'custom' as const, message: 'Unknown validation error', path: [] }]
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Validate override configuration
|
||||
*/
|
||||
validateOverride(config: any, options: ValidationOptions = {}): ValidationResult<OverrideConfig> {
|
||||
const { includeWarnings = true, customValidation } = options
|
||||
|
||||
try {
|
||||
const result = OverrideListSchema.parse(config)
|
||||
|
||||
const warnings: string[] = []
|
||||
|
||||
if (includeWarnings && customValidation) {
|
||||
warnings.push(...customValidation(config))
|
||||
}
|
||||
|
||||
if (includeWarnings) {
|
||||
if (result.overrides.some((override) => !override.reason)) {
|
||||
warnings.push('Some overrides lack reason documentation')
|
||||
}
|
||||
|
||||
if (result.overrides.some((override) => override.priority > 1000)) {
|
||||
warnings.push('Very high priority values may indicate configuration issues')
|
||||
}
|
||||
|
||||
// Check for potential conflicts
|
||||
const modelProviderPairs = result.overrides.map((o) => `${o.modelId}:${o.providerId}`)
|
||||
const duplicates = modelProviderPairs.filter((pair, index) => modelProviderPairs.indexOf(pair) !== index)
|
||||
if (duplicates.length > 0) {
|
||||
warnings.push(`Duplicate override entries detected: ${duplicates.join(', ')}`)
|
||||
}
|
||||
}
|
||||
|
||||
return {
|
||||
success: true,
|
||||
data: result,
|
||||
warnings: warnings.length > 0 ? warnings : undefined
|
||||
}
|
||||
} catch (error) {
|
||||
if (error instanceof z.ZodError) {
|
||||
return {
|
||||
success: false,
|
||||
errors: error.issues
|
||||
}
|
||||
}
|
||||
|
||||
return {
|
||||
success: false,
|
||||
errors: [{ code: 'custom' as const, message: 'Unknown validation error', path: [] }]
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Validate array of configurations
|
||||
*/
|
||||
async validateModelArray(
|
||||
configs: any[],
|
||||
options: ValidationOptions = {}
|
||||
): Promise<{
|
||||
valid: ModelConfig[]
|
||||
invalid: { config: any; errors: z.ZodIssue['path'] extends (string | number)[] ? z.ZodIssue : z.ZodIssue[] }[]
|
||||
warnings: string[]
|
||||
}> {
|
||||
const valid: ModelConfig[] = []
|
||||
const invalid: {
|
||||
config: any
|
||||
errors: z.ZodIssue['path'] extends (string | number)[] ? z.ZodIssue : z.ZodIssue[]
|
||||
}[] = []
|
||||
const allWarnings: string[] = []
|
||||
|
||||
configs.forEach(async (config, index) => {
|
||||
const result = await this.validateModel(config, options)
|
||||
|
||||
if (result.success) {
|
||||
valid.push(result.data!)
|
||||
if (result.warnings) {
|
||||
allWarnings.push(...result.warnings.map((w) => `Model ${index}: ${w}`))
|
||||
}
|
||||
} else {
|
||||
invalid.push({ config, errors: result.errors! })
|
||||
}
|
||||
})
|
||||
|
||||
return { valid, invalid, warnings: allWarnings }
|
||||
}
|
||||
|
||||
/**
|
||||
* Validate provider array
|
||||
*/
|
||||
validateProviderArray(
|
||||
configs: any[],
|
||||
options: ValidationOptions = {}
|
||||
): {
|
||||
valid: ProviderConfig[]
|
||||
invalid: { config: any; errors: z.ZodIssue['path'] extends (string | number)[] ? z.ZodIssue : z.ZodIssue[] }[]
|
||||
warnings: string[]
|
||||
} {
|
||||
const valid: ProviderConfig[] = []
|
||||
const invalid: {
|
||||
config: any
|
||||
errors: z.ZodIssue['path'] extends (string | number)[] ? z.ZodIssue : z.ZodIssue[]
|
||||
}[] = []
|
||||
const allWarnings: string[] = []
|
||||
|
||||
configs.forEach((config, index) => {
|
||||
const result = this.validateProvider(config, options)
|
||||
|
||||
if (result.success) {
|
||||
valid.push(result.data!)
|
||||
if (result.warnings) {
|
||||
allWarnings.push(...result.warnings.map((w) => `Provider ${index}: ${w}`))
|
||||
}
|
||||
} else {
|
||||
invalid.push({ config, errors: result.errors! })
|
||||
}
|
||||
})
|
||||
|
||||
return { valid, invalid, warnings: allWarnings }
|
||||
}
|
||||
|
||||
/**
|
||||
* Format validation errors for display
|
||||
*/
|
||||
formatErrors(errors: z.ZodIssue['path'] extends (string | number)[] ? z.ZodIssue : z.ZodIssue[]): string[] {
|
||||
return errors.map((error) => {
|
||||
const path = error.path.length > 0 ? `${error.path.join('.')}: ` : ''
|
||||
return `${path}${error.message}`
|
||||
})
|
||||
}
|
||||
|
||||
/**
|
||||
* Generate validation summary
|
||||
*/
|
||||
generateSummary(results: {
|
||||
models: {
|
||||
valid: ModelConfig[]
|
||||
invalid: { config: any; errors: z.ZodIssue['path'] extends (string | number)[] ? z.ZodIssue : z.ZodIssue[] }[]
|
||||
warnings: string[]
|
||||
}
|
||||
providers: {
|
||||
valid: ProviderConfig[]
|
||||
invalid: { config: any; errors: z.ZodIssue['path'] extends (string | number)[] ? z.ZodIssue : z.ZodIssue[] }[]
|
||||
warnings: string[]
|
||||
}
|
||||
overrides: ValidationResult<OverrideConfig>
|
||||
}): {
|
||||
totalModels: number
|
||||
validModels: number
|
||||
totalProviders: number
|
||||
validProviders: number
|
||||
overridesValid: boolean
|
||||
allWarnings: string[]
|
||||
} {
|
||||
const { models, providers, overrides } = results
|
||||
|
||||
return {
|
||||
totalModels: models.valid.length + models.invalid.length,
|
||||
validModels: models.valid.length,
|
||||
totalProviders: providers.valid.length + providers.invalid.length,
|
||||
validProviders: providers.valid.length,
|
||||
overridesValid: overrides.success || false,
|
||||
allWarnings: [...models.warnings, ...providers.warnings, ...(overrides.warnings || [])]
|
||||
}
|
||||
}
|
||||
}
|
||||
21
packages/catalog/tsconfig.json
Normal file
21
packages/catalog/tsconfig.json
Normal file
@@ -0,0 +1,21 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"allowSyntheticDefaultImports": true,
|
||||
"declaration": true,
|
||||
"emitDecoratorMetadata": true,
|
||||
"esModuleInterop": true,
|
||||
"experimentalDecorators": true,
|
||||
"forceConsistentCasingInFileNames": true,
|
||||
"module": "ESNext",
|
||||
"moduleResolution": "bundler",
|
||||
"noEmitOnError": false,
|
||||
"outDir": "./dist",
|
||||
"resolveJsonModule": true,
|
||||
"rootDir": "./src",
|
||||
"skipLibCheck": true,
|
||||
"strict": true,
|
||||
"target": "ES2020"
|
||||
},
|
||||
"exclude": ["node_modules", "dist"],
|
||||
"include": ["src/**/*", "scripts"]
|
||||
}
|
||||
12
packages/catalog/tsdown.config.ts
Normal file
12
packages/catalog/tsdown.config.ts
Normal file
@@ -0,0 +1,12 @@
|
||||
import { defineConfig } from 'tsdown'
|
||||
|
||||
export default defineConfig({
|
||||
entry: {
|
||||
index: 'src/index.ts'
|
||||
},
|
||||
outDir: 'dist',
|
||||
format: ['esm', 'cjs'],
|
||||
clean: true,
|
||||
dts: true,
|
||||
tsconfig: 'tsconfig.json'
|
||||
})
|
||||
41
packages/catalog/web/.gitignore
vendored
Normal file
41
packages/catalog/web/.gitignore
vendored
Normal file
@@ -0,0 +1,41 @@
|
||||
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
|
||||
|
||||
# dependencies
|
||||
/node_modules
|
||||
/.pnp
|
||||
.pnp.*
|
||||
.yarn/*
|
||||
!.yarn/patches
|
||||
!.yarn/plugins
|
||||
!.yarn/releases
|
||||
!.yarn/versions
|
||||
|
||||
# testing
|
||||
/coverage
|
||||
|
||||
# next.js
|
||||
/.next/
|
||||
/out/
|
||||
|
||||
# production
|
||||
/build
|
||||
|
||||
# misc
|
||||
.DS_Store
|
||||
*.pem
|
||||
|
||||
# debug
|
||||
npm-debug.log*
|
||||
yarn-debug.log*
|
||||
yarn-error.log*
|
||||
.pnpm-debug.log*
|
||||
|
||||
# env files (can opt-in for committing if needed)
|
||||
.env*
|
||||
|
||||
# vercel
|
||||
.vercel
|
||||
|
||||
# typescript
|
||||
*.tsbuildinfo
|
||||
next-env.d.ts
|
||||
36
packages/catalog/web/README.md
Normal file
36
packages/catalog/web/README.md
Normal file
@@ -0,0 +1,36 @@
|
||||
This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
|
||||
|
||||
## Getting Started
|
||||
|
||||
First, run the development server:
|
||||
|
||||
```bash
|
||||
npm run dev
|
||||
# or
|
||||
yarn dev
|
||||
# or
|
||||
pnpm dev
|
||||
# or
|
||||
bun dev
|
||||
```
|
||||
|
||||
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
|
||||
|
||||
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
|
||||
|
||||
This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
|
||||
|
||||
## Learn More
|
||||
|
||||
To learn more about Next.js, take a look at the following resources:
|
||||
|
||||
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
|
||||
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
|
||||
|
||||
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
|
||||
|
||||
## Deploy on Vercel
|
||||
|
||||
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
|
||||
|
||||
Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
|
||||
@@ -0,0 +1,285 @@
|
||||
import { promises as fs } from 'fs'
|
||||
import type { NextRequest } from 'next/server'
|
||||
import { NextResponse } from 'next/server'
|
||||
import path from 'path'
|
||||
import { z } from 'zod'
|
||||
|
||||
import type { Model, ProviderModelOverride, OverridesDataFile } from '@/lib/catalog-types'
|
||||
import {
|
||||
ModelSchema,
|
||||
ModelsDataFileSchema,
|
||||
ProvidersDataFileSchema,
|
||||
OverridesDataFileSchema
|
||||
} from '@/lib/catalog-types'
|
||||
import { safeParseWithValidation, validateString, ValidationError, createErrorResponse } from '@/lib/validation'
|
||||
|
||||
const DATA_DIR = path.join(process.cwd(), '../data')
|
||||
|
||||
// Type-safe helper function to apply overrides to base model
|
||||
function applyOverrides(baseModel: Model, override: ProviderModelOverride | null): Model {
|
||||
if (!override) return baseModel
|
||||
|
||||
return {
|
||||
...baseModel,
|
||||
...(override.limits && {
|
||||
context_window: override.limits.context_window ?? baseModel.context_window,
|
||||
max_output_tokens: override.limits.max_output_tokens ?? baseModel.max_output_tokens
|
||||
}),
|
||||
...(override.pricing && { pricing: override.pricing })
|
||||
}
|
||||
}
|
||||
|
||||
// Type-safe helper function to detect model modifications
|
||||
function detectModifications(
|
||||
baseModel: Model,
|
||||
updatedModel: Partial<Model>
|
||||
): {
|
||||
pricing: Model['pricing'] | undefined
|
||||
limits:
|
||||
| {
|
||||
context_window?: number
|
||||
max_output_tokens?: number
|
||||
}
|
||||
| undefined
|
||||
} | null {
|
||||
const modifications: {
|
||||
pricing: Model['pricing'] | undefined
|
||||
limits:
|
||||
| {
|
||||
context_window?: number
|
||||
max_output_tokens?: number
|
||||
}
|
||||
| undefined
|
||||
} = {
|
||||
pricing: undefined,
|
||||
limits: undefined
|
||||
}
|
||||
|
||||
// Check for differences in pricing
|
||||
if (JSON.stringify(baseModel.pricing) !== JSON.stringify(updatedModel.pricing)) {
|
||||
modifications.pricing = updatedModel.pricing
|
||||
}
|
||||
|
||||
// Check for differences in limits
|
||||
if (
|
||||
baseModel.context_window !== updatedModel.context_window ||
|
||||
baseModel.max_output_tokens !== updatedModel.max_output_tokens
|
||||
) {
|
||||
modifications.limits = {}
|
||||
if (baseModel.context_window !== updatedModel.context_window) {
|
||||
modifications.limits.context_window = updatedModel.context_window
|
||||
}
|
||||
if (baseModel.max_output_tokens !== updatedModel.max_output_tokens) {
|
||||
modifications.limits.max_output_tokens = updatedModel.max_output_tokens
|
||||
}
|
||||
}
|
||||
|
||||
return modifications.pricing || modifications.limits ? modifications : null
|
||||
}
|
||||
|
||||
export async function GET(request: NextRequest, { params }: { params: { modelId: string; providerId: string } }) {
|
||||
try {
|
||||
const { modelId, providerId } = params
|
||||
|
||||
// Validate parameters
|
||||
const validModelId = validateString(modelId, 'modelId')
|
||||
const validProviderId = validateString(providerId, 'providerId')
|
||||
|
||||
// Read and validate all data files
|
||||
const [modelsDataRaw, providersDataRaw, overridesDataRaw] = await Promise.all([
|
||||
fs.readFile(path.join(DATA_DIR, 'models.json'), 'utf-8'),
|
||||
fs.readFile(path.join(DATA_DIR, 'providers.json'), 'utf-8'),
|
||||
fs.readFile(path.join(DATA_DIR, 'overrides.json'), 'utf-8')
|
||||
])
|
||||
|
||||
const modelsData = await safeParseWithValidation(
|
||||
modelsDataRaw,
|
||||
ModelsDataFileSchema,
|
||||
'Invalid models data format in file'
|
||||
)
|
||||
const providersData = await safeParseWithValidation(
|
||||
providersDataRaw,
|
||||
ProvidersDataFileSchema,
|
||||
'Invalid providers data format in file'
|
||||
)
|
||||
const overridesData = await safeParseWithValidation(
|
||||
overridesDataRaw,
|
||||
OverridesDataFileSchema,
|
||||
'Invalid overrides data format in file'
|
||||
)
|
||||
|
||||
// Find base model
|
||||
const baseModel = modelsData.models.find((m) => m.id === validModelId)
|
||||
if (!baseModel) {
|
||||
return NextResponse.json(createErrorResponse('Model not found', 404), { status: 404 })
|
||||
}
|
||||
|
||||
// Find provider override for this model
|
||||
const override = overridesData.overrides.find(
|
||||
(o) => o.model_id === validModelId && o.provider_id === validProviderId
|
||||
)
|
||||
|
||||
// Apply override if exists
|
||||
const finalModel = applyOverrides(baseModel, override || null)
|
||||
|
||||
return NextResponse.json(ModelSchema.parse(finalModel))
|
||||
} catch (error) {
|
||||
if (error instanceof ValidationError) {
|
||||
console.error('Validation error:', error.message, error.details)
|
||||
return NextResponse.json(createErrorResponse(error.message, 400, error.details), { status: 400 })
|
||||
}
|
||||
|
||||
console.error('Error fetching provider model:', error)
|
||||
return NextResponse.json(
|
||||
createErrorResponse(
|
||||
'Failed to fetch model configuration',
|
||||
500,
|
||||
error instanceof Error ? error.message : 'Unknown error'
|
||||
),
|
||||
{ status: 500 }
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
// Response schema for provider model updates
|
||||
const ProviderModelUpdateResponseSchema = z.object({
|
||||
updated: z.enum(['base_model', 'override', 'override_updated', 'override_removed']),
|
||||
model: ModelSchema
|
||||
})
|
||||
|
||||
export async function PUT(request: NextRequest, { params }: { params: { modelId: string; providerId: string } }) {
|
||||
try {
|
||||
const { modelId, providerId } = params
|
||||
|
||||
// Validate parameters
|
||||
const validModelId = validateString(modelId, 'modelId')
|
||||
const validProviderId = validateString(providerId, 'providerId')
|
||||
|
||||
// Validate request body
|
||||
const requestBody = await request.json()
|
||||
const updatedModel = await safeParseWithValidation(
|
||||
JSON.stringify(requestBody),
|
||||
ModelSchema.partial(),
|
||||
'Invalid model data in request body'
|
||||
)
|
||||
|
||||
// Read and validate current data
|
||||
const [modelsDataRaw, providersDataRaw, overridesDataRaw] = await Promise.all([
|
||||
fs.readFile(path.join(DATA_DIR, 'models.json'), 'utf-8'),
|
||||
fs.readFile(path.join(DATA_DIR, 'providers.json'), 'utf-8'),
|
||||
fs.readFile(path.join(DATA_DIR, 'overrides.json'), 'utf-8')
|
||||
])
|
||||
|
||||
const modelsData = await safeParseWithValidation(
|
||||
modelsDataRaw,
|
||||
ModelsDataFileSchema,
|
||||
'Invalid models data format in file'
|
||||
)
|
||||
const providersData = await safeParseWithValidation(
|
||||
providersDataRaw,
|
||||
ProvidersDataFileSchema,
|
||||
'Invalid providers data format in file'
|
||||
)
|
||||
const overridesData = await safeParseWithValidation(
|
||||
overridesDataRaw,
|
||||
OverridesDataFileSchema,
|
||||
'Invalid overrides data format in file'
|
||||
)
|
||||
|
||||
// Find base model and existing override
|
||||
const baseModelIndex = modelsData.models.findIndex((m) => m.id === validModelId)
|
||||
const existingOverrideIndex = overridesData.overrides.findIndex(
|
||||
(o) => o.model_id === validModelId && o.provider_id === validProviderId
|
||||
)
|
||||
|
||||
if (baseModelIndex === -1) {
|
||||
return NextResponse.json(createErrorResponse('Base model not found', 404), { status: 404 })
|
||||
}
|
||||
|
||||
const baseModel = modelsData.models[baseModelIndex]
|
||||
|
||||
// Detect what needs to be overridden
|
||||
const modifications = detectModifications(baseModel, updatedModel)
|
||||
|
||||
let updated: 'base_model' | 'override' | 'override_updated' | 'override_removed' = 'base_model'
|
||||
let overrideCreated = false
|
||||
|
||||
if (modifications) {
|
||||
// Create or update override
|
||||
const override: ProviderModelOverride = {
|
||||
provider_id: validProviderId,
|
||||
model_id: validModelId,
|
||||
disabled: false,
|
||||
reason: 'Manual configuration update',
|
||||
last_updated: new Date().toISOString().split('T')[0],
|
||||
updated_by: 'web-interface',
|
||||
priority: 100,
|
||||
...modifications
|
||||
}
|
||||
|
||||
const updatedOverrides = [...overridesData.overrides]
|
||||
|
||||
if (existingOverrideIndex >= 0) {
|
||||
updatedOverrides[existingOverrideIndex] = {
|
||||
...updatedOverrides[existingOverrideIndex],
|
||||
...override,
|
||||
last_updated: new Date().toISOString().split('T')[0]
|
||||
}
|
||||
} else {
|
||||
updatedOverrides.push(override)
|
||||
overrideCreated = true
|
||||
}
|
||||
|
||||
const updatedOverridesData: OverridesDataFile = {
|
||||
...overridesData,
|
||||
overrides: updatedOverrides
|
||||
}
|
||||
|
||||
updated = overrideCreated ? 'override' : 'override_updated'
|
||||
|
||||
// Save changes to overrides file
|
||||
await fs.writeFile(path.join(DATA_DIR, 'overrides.json'), JSON.stringify(updatedOverridesData, null, 2), 'utf-8')
|
||||
} else if (existingOverrideIndex >= 0) {
|
||||
// Remove override if no differences exist
|
||||
const updatedOverrides = overridesData.overrides.filter((_, index) => index !== existingOverrideIndex)
|
||||
|
||||
const updatedOverridesData: OverridesDataFile = {
|
||||
...overridesData,
|
||||
overrides: updatedOverrides
|
||||
}
|
||||
|
||||
updated = 'override_removed'
|
||||
|
||||
// Save changes to overrides file
|
||||
await fs.writeFile(path.join(DATA_DIR, 'overrides.json'), JSON.stringify(updatedOverridesData, null, 2), 'utf-8')
|
||||
}
|
||||
|
||||
// Return the final model configuration
|
||||
const finalOverride = overridesData.overrides.find(
|
||||
(o) => o.model_id === validModelId && o.provider_id === validProviderId
|
||||
)
|
||||
const finalModel = applyOverrides(baseModel, finalOverride || null)
|
||||
|
||||
const response = ProviderModelUpdateResponseSchema.parse({
|
||||
updated,
|
||||
model: finalModel
|
||||
})
|
||||
|
||||
return NextResponse.json(response)
|
||||
} catch (error) {
|
||||
if (error instanceof ValidationError) {
|
||||
console.error('Validation error:', error.message, error.details)
|
||||
return NextResponse.json(createErrorResponse(error.message, 400, error.details), { status: 400 })
|
||||
}
|
||||
|
||||
console.error('Error updating provider model:', error)
|
||||
return NextResponse.json(
|
||||
createErrorResponse(
|
||||
'Failed to update model configuration',
|
||||
500,
|
||||
error instanceof Error ? error.message : 'Unknown error'
|
||||
),
|
||||
{ status: 500 }
|
||||
)
|
||||
}
|
||||
}
|
||||
113
packages/catalog/web/app/api/catalog/models/[modelId]/route.ts
Normal file
113
packages/catalog/web/app/api/catalog/models/[modelId]/route.ts
Normal file
@@ -0,0 +1,113 @@
|
||||
import { promises as fs } from 'fs'
|
||||
import type { NextRequest } from 'next/server'
|
||||
import { NextResponse } from 'next/server'
|
||||
import path from 'path'
|
||||
|
||||
import type { ModelsDataFile } from '@/lib/catalog-types'
|
||||
import { ModelSchema, ModelsDataFileSchema, ModelUpdateResponseSchema } from '@/lib/catalog-types'
|
||||
import { createErrorResponse, safeParseWithValidation, ValidationError } from '@/lib/validation'
|
||||
|
||||
const DATA_DIR = path.join(process.cwd(), '../data')
|
||||
|
||||
export async function GET(request: NextRequest, { params }: { params: { modelId: string } }) {
|
||||
try {
|
||||
const { modelId } = params
|
||||
|
||||
// Read and validate models data using Zod
|
||||
const modelsDataPath = path.join(DATA_DIR, 'models.json')
|
||||
const modelsDataRaw = await fs.readFile(modelsDataPath, 'utf-8')
|
||||
const modelsData = await safeParseWithValidation(
|
||||
modelsDataRaw,
|
||||
ModelsDataFileSchema,
|
||||
'Invalid models data format in file'
|
||||
)
|
||||
|
||||
// Find the model with type safety
|
||||
const model = modelsData.models.find((m) => m.id === modelId)
|
||||
if (!model) {
|
||||
return NextResponse.json(createErrorResponse('Model not found', 404), { status: 404 })
|
||||
}
|
||||
|
||||
return NextResponse.json(model)
|
||||
} catch (error) {
|
||||
if (error instanceof ValidationError) {
|
||||
console.error('Validation error:', error.message, error.details)
|
||||
return NextResponse.json(createErrorResponse(error.message, 400, error.details), { status: 400 })
|
||||
}
|
||||
|
||||
console.error('Error fetching model:', error)
|
||||
return NextResponse.json(
|
||||
createErrorResponse('Failed to fetch model', 500, error instanceof Error ? error.message : 'Unknown error'),
|
||||
{ status: 500 }
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
export async function PUT(request: NextRequest, { params }: { params: { modelId: string } }) {
|
||||
try {
|
||||
const { modelId } = params
|
||||
|
||||
// Read and validate request body using Zod
|
||||
const requestBody = await request.json()
|
||||
const updatedModel = await safeParseWithValidation(
|
||||
JSON.stringify(requestBody),
|
||||
ModelSchema,
|
||||
'Invalid model data in request body'
|
||||
)
|
||||
|
||||
// Validate that the model ID matches
|
||||
if (updatedModel.id !== modelId) {
|
||||
return NextResponse.json(createErrorResponse('Model ID in request body must match URL parameter', 400), {
|
||||
status: 400
|
||||
})
|
||||
}
|
||||
|
||||
// Read current models data using Zod
|
||||
const modelsDataPath = path.join(DATA_DIR, 'models.json')
|
||||
const modelsDataRaw = await fs.readFile(modelsDataPath, 'utf-8')
|
||||
const modelsData = await safeParseWithValidation(
|
||||
modelsDataRaw,
|
||||
ModelsDataFileSchema,
|
||||
'Invalid models data format in file'
|
||||
)
|
||||
|
||||
// Find and update the model
|
||||
const modelIndex = modelsData.models.findIndex((m) => m.id === modelId)
|
||||
if (modelIndex === -1) {
|
||||
return NextResponse.json(createErrorResponse('Model not found', 404), { status: 404 })
|
||||
}
|
||||
|
||||
// Create updated models array (immutability)
|
||||
const updatedModels = [
|
||||
...modelsData.models.slice(0, modelIndex),
|
||||
updatedModel,
|
||||
...modelsData.models.slice(modelIndex + 1)
|
||||
]
|
||||
|
||||
const updatedModelsData: ModelsDataFile = {
|
||||
...modelsData,
|
||||
models: updatedModels
|
||||
}
|
||||
|
||||
// Write back to file
|
||||
await fs.writeFile(modelsDataPath, JSON.stringify(updatedModelsData, null, 2), 'utf-8')
|
||||
|
||||
const response = ModelUpdateResponseSchema.parse({
|
||||
success: true,
|
||||
model: updatedModel
|
||||
})
|
||||
|
||||
return NextResponse.json(response)
|
||||
} catch (error) {
|
||||
if (error instanceof ValidationError) {
|
||||
console.error('Validation error:', error.message, error.details)
|
||||
return NextResponse.json(createErrorResponse(error.message, 400, error.details), { status: 400 })
|
||||
}
|
||||
|
||||
console.error('Error updating model:', error)
|
||||
return NextResponse.json(
|
||||
createErrorResponse('Failed to update model', 500, error instanceof Error ? error.message : 'Unknown error'),
|
||||
{ status: 500 }
|
||||
)
|
||||
}
|
||||
}
|
||||
156
packages/catalog/web/app/api/catalog/models/route.ts
Normal file
156
packages/catalog/web/app/api/catalog/models/route.ts
Normal file
@@ -0,0 +1,156 @@
|
||||
import { promises as fs } from 'fs'
|
||||
import type { NextRequest } from 'next/server'
|
||||
import { NextResponse } from 'next/server'
|
||||
import path from 'path'
|
||||
|
||||
import type { Model } from '@/lib/catalog-types'
|
||||
import {
|
||||
ModelSchema,
|
||||
ModelsDataFileSchema
|
||||
} from '@/lib/catalog-types'
|
||||
import {
|
||||
createErrorResponse,
|
||||
safeParseWithValidation,
|
||||
validatePaginatedResponse,
|
||||
validateQueryParams,
|
||||
ValidationError
|
||||
} from '@/lib/validation'
|
||||
|
||||
const DATA_DIR = path.join(process.cwd(), '../data')
|
||||
|
||||
function filterModels(
|
||||
models: readonly Model[],
|
||||
search?: string,
|
||||
capabilities?: string[],
|
||||
providers?: string[]
|
||||
): Model[] {
|
||||
let filtered = [...models]
|
||||
|
||||
if (search) {
|
||||
const searchLower = search.toLowerCase()
|
||||
filtered = filtered.filter(
|
||||
(model) =>
|
||||
model.id.toLowerCase().includes(searchLower) ||
|
||||
model.name?.toLowerCase().includes(searchLower) ||
|
||||
model.owned_by?.toLowerCase().includes(searchLower)
|
||||
)
|
||||
}
|
||||
|
||||
if (capabilities && capabilities.length > 0) {
|
||||
filtered = filtered.filter((model) => capabilities.some((cap) => model.capabilities.includes(cap)))
|
||||
}
|
||||
|
||||
if (providers && providers.length > 0) {
|
||||
filtered = filtered.filter((model) => model.owned_by && providers.includes(model.owned_by))
|
||||
}
|
||||
|
||||
return filtered
|
||||
}
|
||||
|
||||
function paginateItems<T>(
|
||||
items: readonly T[],
|
||||
page: number,
|
||||
limit: number
|
||||
): {
|
||||
items: T[]
|
||||
pagination: {
|
||||
page: number
|
||||
limit: number
|
||||
total: number
|
||||
totalPages: number
|
||||
hasNext: boolean
|
||||
hasPrev: boolean
|
||||
}
|
||||
} {
|
||||
const total = items.length
|
||||
const totalPages = Math.ceil(total / limit)
|
||||
const offset = (page - 1) * limit
|
||||
const paginatedItems = items.slice(offset, offset + limit)
|
||||
|
||||
return {
|
||||
items: paginatedItems,
|
||||
pagination: {
|
||||
page,
|
||||
limit,
|
||||
total,
|
||||
totalPages,
|
||||
hasNext: page < totalPages,
|
||||
hasPrev: page > 1
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export async function GET(request: NextRequest) {
|
||||
try {
|
||||
const { searchParams } = new URL(request.url)
|
||||
|
||||
// Validate query parameters using Zod
|
||||
const validatedParams = validateQueryParams(searchParams)
|
||||
|
||||
// Read and validate models data using Zod
|
||||
const modelsDataPath = path.join(DATA_DIR, 'models.json')
|
||||
const modelsDataRaw = await fs.readFile(modelsDataPath, 'utf-8')
|
||||
const modelsData = await safeParseWithValidation(
|
||||
modelsDataRaw,
|
||||
ModelsDataFileSchema,
|
||||
'Invalid models data format in file'
|
||||
)
|
||||
|
||||
// Filter models with type safety
|
||||
const filteredModels = filterModels(
|
||||
modelsData.models,
|
||||
validatedParams.search,
|
||||
validatedParams.capabilities,
|
||||
validatedParams.providers
|
||||
)
|
||||
|
||||
// Paginate results
|
||||
const { items, pagination } = paginateItems(filteredModels, validatedParams.page, validatedParams.limit)
|
||||
|
||||
// Create paginated response using Zod schema
|
||||
const response = validatePaginatedResponse({ data: items, pagination }, ModelSchema)
|
||||
|
||||
return NextResponse.json(response)
|
||||
} catch (error) {
|
||||
if (error instanceof ValidationError) {
|
||||
console.error('Validation error:', error.message, error.details)
|
||||
return NextResponse.json(createErrorResponse(error.message, 400, error.details), { status: 400 })
|
||||
}
|
||||
|
||||
console.error('Error fetching models:', error)
|
||||
return NextResponse.json(
|
||||
createErrorResponse('Failed to fetch models', 500, error instanceof Error ? error.message : 'Unknown error'),
|
||||
{ status: 500 }
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
export async function PUT(request: NextRequest) {
|
||||
try {
|
||||
const body = await request.json()
|
||||
|
||||
// Validate the data structure using Zod
|
||||
const validatedData = await safeParseWithValidation(
|
||||
JSON.stringify(body),
|
||||
ModelsDataFileSchema,
|
||||
'Invalid models data format in request body'
|
||||
)
|
||||
|
||||
// Write validated data back to file
|
||||
const modelsDataPath = path.join(DATA_DIR, 'models.json')
|
||||
await fs.writeFile(modelsDataPath, JSON.stringify(validatedData, null, 2), 'utf-8')
|
||||
|
||||
return NextResponse.json({ success: true })
|
||||
} catch (error) {
|
||||
if (error instanceof ValidationError) {
|
||||
console.error('Validation error:', error.message, error.details)
|
||||
return NextResponse.json(createErrorResponse(error.message, 400, error.details), { status: 400 })
|
||||
}
|
||||
|
||||
console.error('Error updating models:', error)
|
||||
return NextResponse.json(
|
||||
createErrorResponse('Failed to update models', 500, error instanceof Error ? error.message : 'Unknown error'),
|
||||
{ status: 500 }
|
||||
)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,113 @@
|
||||
import { promises as fs } from 'fs'
|
||||
import type { NextRequest } from 'next/server'
|
||||
import { NextResponse } from 'next/server'
|
||||
import path from 'path'
|
||||
|
||||
import type { ProvidersDataFile } from '@/lib/catalog-types'
|
||||
import { ProviderSchema, ProvidersDataFileSchema, ProviderUpdateResponseSchema } from '@/lib/catalog-types'
|
||||
import { createErrorResponse, safeParseWithValidation, ValidationError } from '@/lib/validation'
|
||||
|
||||
const DATA_DIR = path.join(process.cwd(), '../data')
|
||||
|
||||
export async function GET(request: NextRequest, { params }: { params: { providerId: string } }) {
|
||||
try {
|
||||
const { providerId } = params
|
||||
|
||||
// Read and validate providers data using Zod
|
||||
const providersDataPath = path.join(DATA_DIR, 'providers.json')
|
||||
const providersDataRaw = await fs.readFile(providersDataPath, 'utf-8')
|
||||
const providersData = await safeParseWithValidation(
|
||||
providersDataRaw,
|
||||
ProvidersDataFileSchema,
|
||||
'Invalid providers data format in file'
|
||||
)
|
||||
|
||||
// Find the provider with type safety
|
||||
const provider = providersData.providers.find((p) => p.id === providerId)
|
||||
if (!provider) {
|
||||
return NextResponse.json(createErrorResponse('Provider not found', 404), { status: 404 })
|
||||
}
|
||||
|
||||
return NextResponse.json(provider)
|
||||
} catch (error) {
|
||||
if (error instanceof ValidationError) {
|
||||
console.error('Validation error:', error.message, error.details)
|
||||
return NextResponse.json(createErrorResponse(error.message, 400, error.details), { status: 400 })
|
||||
}
|
||||
|
||||
console.error('Error fetching provider:', error)
|
||||
return NextResponse.json(
|
||||
createErrorResponse('Failed to fetch provider', 500, error instanceof Error ? error.message : 'Unknown error'),
|
||||
{ status: 500 }
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
export async function PUT(request: NextRequest, { params }: { params: { providerId: string } }) {
|
||||
try {
|
||||
const { providerId } = params
|
||||
|
||||
// Read and validate request body using Zod
|
||||
const requestBody = await request.json()
|
||||
const updatedProvider = await safeParseWithValidation(
|
||||
JSON.stringify(requestBody),
|
||||
ProviderSchema,
|
||||
'Invalid provider data in request body'
|
||||
)
|
||||
|
||||
// Validate that the provider ID matches
|
||||
if (updatedProvider.id !== providerId) {
|
||||
return NextResponse.json(createErrorResponse('Provider ID in request body must match URL parameter', 400), {
|
||||
status: 400
|
||||
})
|
||||
}
|
||||
|
||||
// Read current providers data using Zod
|
||||
const providersDataPath = path.join(DATA_DIR, 'providers.json')
|
||||
const providersDataRaw = await fs.readFile(providersDataPath, 'utf-8')
|
||||
const providersData = await safeParseWithValidation(
|
||||
providersDataRaw,
|
||||
ProvidersDataFileSchema,
|
||||
'Invalid providers data format in file'
|
||||
)
|
||||
|
||||
// Find and update the provider
|
||||
const providerIndex = providersData.providers.findIndex((p) => p.id === providerId)
|
||||
if (providerIndex === -1) {
|
||||
return NextResponse.json(createErrorResponse('Provider not found', 404), { status: 404 })
|
||||
}
|
||||
|
||||
// Create updated providers array (immutability)
|
||||
const updatedProviders = [
|
||||
...providersData.providers.slice(0, providerIndex),
|
||||
updatedProvider,
|
||||
...providersData.providers.slice(providerIndex + 1)
|
||||
]
|
||||
|
||||
const updatedProvidersData: ProvidersDataFile = {
|
||||
...providersData,
|
||||
providers: updatedProviders
|
||||
}
|
||||
|
||||
// Write back to file
|
||||
await fs.writeFile(providersDataPath, JSON.stringify(updatedProvidersData, null, 2), 'utf-8')
|
||||
|
||||
const response = ProviderUpdateResponseSchema.parse({
|
||||
success: true,
|
||||
provider: updatedProvider
|
||||
})
|
||||
|
||||
return NextResponse.json(response)
|
||||
} catch (error) {
|
||||
if (error instanceof ValidationError) {
|
||||
console.error('Validation error:', error.message, error.details)
|
||||
return NextResponse.json(createErrorResponse(error.message, 400, error.details), { status: 400 })
|
||||
}
|
||||
|
||||
console.error('Error updating provider:', error)
|
||||
return NextResponse.json(
|
||||
createErrorResponse('Failed to update provider', 500, error instanceof Error ? error.message : 'Unknown error'),
|
||||
{ status: 500 }
|
||||
)
|
||||
}
|
||||
}
|
||||
146
packages/catalog/web/app/api/catalog/providers/route.ts
Normal file
146
packages/catalog/web/app/api/catalog/providers/route.ts
Normal file
@@ -0,0 +1,146 @@
|
||||
import { promises as fs } from 'fs'
|
||||
import type { NextRequest } from 'next/server'
|
||||
import { NextResponse } from 'next/server'
|
||||
import path from 'path'
|
||||
|
||||
import type { Provider } from '@/lib/catalog-types'
|
||||
import {
|
||||
ProviderSchema,
|
||||
ProvidersDataFileSchema
|
||||
} from '@/lib/catalog-types'
|
||||
import {
|
||||
createErrorResponse,
|
||||
safeParseWithValidation,
|
||||
validatePaginatedResponse,
|
||||
validateQueryParams,
|
||||
ValidationError
|
||||
} from '@/lib/validation'
|
||||
|
||||
const DATA_DIR = path.join(process.cwd(), '../data')
|
||||
|
||||
function filterProviders(providers: readonly Provider[], search?: string, authentication?: string[]): Provider[] {
|
||||
let filtered = [...providers]
|
||||
|
||||
if (search) {
|
||||
const searchLower = search.toLowerCase()
|
||||
filtered = filtered.filter(
|
||||
(provider) =>
|
||||
provider.id.toLowerCase().includes(searchLower) ||
|
||||
provider.name.toLowerCase().includes(searchLower) ||
|
||||
provider.description?.toLowerCase().includes(searchLower)
|
||||
)
|
||||
}
|
||||
|
||||
if (authentication && authentication.length > 0) {
|
||||
filtered = filtered.filter((provider) => authentication.includes(provider.authentication))
|
||||
}
|
||||
|
||||
return filtered
|
||||
}
|
||||
|
||||
function paginateItems<T>(
|
||||
items: readonly T[],
|
||||
page: number,
|
||||
limit: number
|
||||
): {
|
||||
items: T[]
|
||||
pagination: {
|
||||
page: number
|
||||
limit: number
|
||||
total: number
|
||||
totalPages: number
|
||||
hasNext: boolean
|
||||
hasPrev: boolean
|
||||
}
|
||||
} {
|
||||
const total = items.length
|
||||
const totalPages = Math.ceil(total / limit)
|
||||
const offset = (page - 1) * limit
|
||||
const paginatedItems = items.slice(offset, offset + limit)
|
||||
|
||||
return {
|
||||
items: paginatedItems,
|
||||
pagination: {
|
||||
page,
|
||||
limit,
|
||||
total,
|
||||
totalPages,
|
||||
hasNext: page < totalPages,
|
||||
hasPrev: page > 1
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export async function GET(request: NextRequest) {
|
||||
try {
|
||||
const { searchParams } = new URL(request.url)
|
||||
|
||||
// Validate query parameters using Zod
|
||||
const validatedParams = validateQueryParams(searchParams)
|
||||
|
||||
// Read and validate providers data using Zod
|
||||
const providersDataPath = path.join(DATA_DIR, 'providers.json')
|
||||
const providersDataRaw = await fs.readFile(providersDataPath, 'utf-8')
|
||||
const providersData = await safeParseWithValidation(
|
||||
providersDataRaw,
|
||||
ProvidersDataFileSchema,
|
||||
'Invalid providers data format in file'
|
||||
)
|
||||
|
||||
// Filter providers with type safety
|
||||
const filteredProviders = filterProviders(
|
||||
providersData.providers,
|
||||
validatedParams.search,
|
||||
validatedParams.authentication
|
||||
)
|
||||
|
||||
// Paginate results
|
||||
const { items, pagination } = paginateItems(filteredProviders, validatedParams.page, validatedParams.limit)
|
||||
|
||||
// Create paginated response using Zod schema
|
||||
const response = validatePaginatedResponse({ data: items, pagination }, ProviderSchema)
|
||||
|
||||
return NextResponse.json(response)
|
||||
} catch (error) {
|
||||
if (error instanceof ValidationError) {
|
||||
console.error('Validation error:', error.message, error.details)
|
||||
return NextResponse.json(createErrorResponse(error.message, 400, error.details), { status: 400 })
|
||||
}
|
||||
|
||||
console.error('Error fetching providers:', error)
|
||||
return NextResponse.json(
|
||||
createErrorResponse('Failed to fetch providers', 500, error instanceof Error ? error.message : 'Unknown error'),
|
||||
{ status: 500 }
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
export async function PUT(request: NextRequest) {
|
||||
try {
|
||||
const body = await request.json()
|
||||
|
||||
// Validate the data structure using Zod
|
||||
const validatedData = await safeParseWithValidation(
|
||||
JSON.stringify(body),
|
||||
ProvidersDataFileSchema,
|
||||
'Invalid providers data format in request body'
|
||||
)
|
||||
|
||||
// Write validated data back to file
|
||||
const providersDataPath = path.join(DATA_DIR, 'providers.json')
|
||||
await fs.writeFile(providersDataPath, JSON.stringify(validatedData, null, 2), 'utf-8')
|
||||
|
||||
return NextResponse.json({ success: true })
|
||||
} catch (error) {
|
||||
if (error instanceof ValidationError) {
|
||||
console.error('Validation error:', error.message, error.details)
|
||||
return NextResponse.json(createErrorResponse(error.message, 400, error.details), { status: 400 })
|
||||
}
|
||||
|
||||
console.error('Error updating providers:', error)
|
||||
return NextResponse.json(
|
||||
createErrorResponse('Failed to update providers', 500, error instanceof Error ? error.message : 'Unknown error'),
|
||||
{ status: 500 }
|
||||
)
|
||||
}
|
||||
}
|
||||
70
packages/catalog/web/app/api/catalog/stats/route.ts
Normal file
70
packages/catalog/web/app/api/catalog/stats/route.ts
Normal file
@@ -0,0 +1,70 @@
|
||||
import { promises as fs } from 'fs'
|
||||
import { NextResponse } from 'next/server'
|
||||
import path from 'path'
|
||||
import { z } from 'zod'
|
||||
|
||||
// Define schema for stats response
|
||||
const StatsResponseSchema = z.object({
|
||||
total_models: z.number(),
|
||||
total_providers: z.number(),
|
||||
total_overrides: z.number(),
|
||||
last_updated: z.string().optional(),
|
||||
migration_status: z.enum(['completed', 'in_progress', 'failed']).optional()
|
||||
})
|
||||
|
||||
const DATA_DIR = path.join(process.cwd(), '../data')
|
||||
|
||||
// Define schema for migration report
|
||||
const MigrationReportSchema = z.object({
|
||||
summary: z.object({
|
||||
total_base_models: z.number(),
|
||||
total_providers: z.number(),
|
||||
total_overrides: z.number()
|
||||
})
|
||||
})
|
||||
|
||||
const ModelsDataSchema = z.object({
|
||||
version: z.string(),
|
||||
models: z.array(z.any())
|
||||
})
|
||||
|
||||
export async function GET() {
|
||||
try {
|
||||
// Read migration report for stats with Zod validation
|
||||
const reportData = await fs.readFile(path.join(DATA_DIR, 'migration-report.json'), 'utf-8')
|
||||
const report = MigrationReportSchema.parse(JSON.parse(reportData))
|
||||
|
||||
// Read actual data for last updated timestamp with Zod validation
|
||||
const modelsData = await fs.readFile(path.join(DATA_DIR, 'models.json'), 'utf-8')
|
||||
const models = ModelsDataSchema.parse(JSON.parse(modelsData))
|
||||
|
||||
const stats = {
|
||||
total_models: report.summary.total_base_models,
|
||||
total_providers: report.summary.total_providers,
|
||||
total_overrides: report.summary.total_overrides,
|
||||
last_updated: new Date().toISOString(),
|
||||
version: models.version
|
||||
}
|
||||
|
||||
// Validate response with Zod schema
|
||||
const validatedStats = StatsResponseSchema.parse(stats)
|
||||
|
||||
return NextResponse.json(validatedStats)
|
||||
} catch (error) {
|
||||
console.error('Error fetching stats:', error)
|
||||
|
||||
// Try to provide a minimal fallback response
|
||||
const fallbackStats = {
|
||||
total_models: 0,
|
||||
total_providers: 0,
|
||||
total_overrides: 0
|
||||
}
|
||||
|
||||
try {
|
||||
const validatedFallback = StatsResponseSchema.parse(fallbackStats)
|
||||
return NextResponse.json(validatedFallback)
|
||||
} catch {
|
||||
return NextResponse.json({ error: 'Failed to fetch stats' }, { status: 500 })
|
||||
}
|
||||
}
|
||||
}
|
||||
BIN
packages/catalog/web/app/favicon.ico
Normal file
BIN
packages/catalog/web/app/favicon.ico
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 25 KiB |
26
packages/catalog/web/app/globals.css
Normal file
26
packages/catalog/web/app/globals.css
Normal file
@@ -0,0 +1,26 @@
|
||||
@import 'tailwindcss';
|
||||
|
||||
:root {
|
||||
--background: #ffffff;
|
||||
--foreground: #171717;
|
||||
}
|
||||
|
||||
@theme inline {
|
||||
--color-background: var(--background);
|
||||
--color-foreground: var(--foreground);
|
||||
--font-sans: var(--font-geist-sans);
|
||||
--font-mono: var(--font-geist-mono);
|
||||
}
|
||||
|
||||
@media (prefers-color-scheme: dark) {
|
||||
:root {
|
||||
--background: #0a0a0a;
|
||||
--foreground: #ededed;
|
||||
}
|
||||
}
|
||||
|
||||
body {
|
||||
background: var(--background);
|
||||
color: var(--foreground);
|
||||
font-family: Arial, Helvetica, sans-serif;
|
||||
}
|
||||
31
packages/catalog/web/app/layout.tsx
Normal file
31
packages/catalog/web/app/layout.tsx
Normal file
@@ -0,0 +1,31 @@
|
||||
import './globals.css'
|
||||
|
||||
import type { Metadata } from 'next'
|
||||
import { Geist, Geist_Mono } from 'next/font/google'
|
||||
|
||||
const geistSans = Geist({
|
||||
variable: '--font-geist-sans',
|
||||
subsets: ['latin']
|
||||
})
|
||||
|
||||
const geistMono = Geist_Mono({
|
||||
variable: '--font-geist-mono',
|
||||
subsets: ['latin']
|
||||
})
|
||||
|
||||
export const metadata: Metadata = {
|
||||
title: 'Create Next App',
|
||||
description: 'Generated by create next app'
|
||||
}
|
||||
|
||||
export default function RootLayout({
|
||||
children
|
||||
}: Readonly<{
|
||||
children: React.ReactNode
|
||||
}>) {
|
||||
return (
|
||||
<html lang="en">
|
||||
<body className={`${geistSans.variable} ${geistMono.variable} antialiased`}>{children}</body>
|
||||
</html>
|
||||
)
|
||||
}
|
||||
348
packages/catalog/web/app/page.tsx
Normal file
348
packages/catalog/web/app/page.tsx
Normal file
@@ -0,0 +1,348 @@
|
||||
'use client'
|
||||
|
||||
import { useState } from 'react'
|
||||
|
||||
import { Navigation } from '@/components/navigation'
|
||||
import { Alert, AlertDescription } from '@/components/ui/alert'
|
||||
import { Badge } from '@/components/ui/badge'
|
||||
import { Button } from '@/components/ui/button'
|
||||
import { Card, CardContent, CardDescription, CardHeader, CardTitle } from '@/components/ui/card'
|
||||
import {
|
||||
Dialog,
|
||||
DialogContent,
|
||||
DialogDescription,
|
||||
DialogHeader,
|
||||
DialogTitle,
|
||||
DialogTrigger
|
||||
} from '@/components/ui/dialog'
|
||||
import { Input } from '@/components/ui/input'
|
||||
import { Separator } from '@/components/ui/separator'
|
||||
import { Table, TableBody, TableCell, TableHead, TableHeader, TableRow } from '@/components/ui/table'
|
||||
import { Textarea } from '@/components/ui/textarea'
|
||||
// Import SWR hooks and utilities
|
||||
import { getErrorMessage, useDebounce, useModels, useUpdateModel } from '@/lib/api-client'
|
||||
import type { CapabilityType, Model } from '@/lib/catalog-types'
|
||||
|
||||
// Type-safe capabilities list
|
||||
const CAPABILITIES: readonly CapabilityType[] = [
|
||||
'FUNCTION_CALL',
|
||||
'REASONING',
|
||||
'IMAGE_RECOGNITION',
|
||||
'IMAGE_GENERATION',
|
||||
'AUDIO_RECOGNITION',
|
||||
'AUDIO_GENERATION',
|
||||
'EMBEDDING',
|
||||
'RERANK',
|
||||
'AUDIO_TRANSCRIPT',
|
||||
'VIDEO_RECOGNITION',
|
||||
'VIDEO_GENERATION',
|
||||
'STRUCTURED_OUTPUT',
|
||||
'FILE_INPUT',
|
||||
'WEB_SEARCH',
|
||||
'CODE_EXECUTION',
|
||||
'FILE_SEARCH',
|
||||
'COMPUTER_USE'
|
||||
] as const
|
||||
|
||||
// Simple Pagination Component
|
||||
function SimplePagination({
|
||||
currentPage,
|
||||
totalPages,
|
||||
onPageChange
|
||||
}: {
|
||||
currentPage: number
|
||||
totalPages: number
|
||||
onPageChange: (page: number) => void
|
||||
}) {
|
||||
const pages = Array.from({ length: Math.min(5, totalPages) }, (_, i) => {
|
||||
if (totalPages <= 5) return i + 1
|
||||
if (currentPage <= 3) return i + 1
|
||||
if (currentPage >= totalPages - 2) return totalPages - 4 + i
|
||||
return currentPage - 2 + i
|
||||
})
|
||||
|
||||
return (
|
||||
<div className="flex items-center gap-2">
|
||||
<Button variant="outline" size="sm" onClick={() => onPageChange(currentPage - 1)} disabled={currentPage <= 1}>
|
||||
Previous
|
||||
</Button>
|
||||
{pages.map((page) => (
|
||||
<Button
|
||||
key={page}
|
||||
variant={currentPage === page ? 'default' : 'outline'}
|
||||
size="sm"
|
||||
onClick={() => onPageChange(page)}>
|
||||
{page}
|
||||
</Button>
|
||||
))}
|
||||
<Button
|
||||
variant="outline"
|
||||
size="sm"
|
||||
onClick={() => onPageChange(currentPage + 1)}
|
||||
disabled={currentPage >= totalPages}>
|
||||
Next
|
||||
</Button>
|
||||
</div>
|
||||
)
|
||||
}
|
||||
|
||||
export default function CatalogReview() {
|
||||
// Form state
|
||||
const [search, setSearch] = useState('')
|
||||
const [selectedCapabilities, setSelectedCapabilities] = useState<string[]>([])
|
||||
const [selectedProviders, setSelectedProviders] = useState<string[]>([])
|
||||
const [currentPage, setCurrentPage] = useState(1)
|
||||
const [editingModel, setEditingModel] = useState<Model | null>(null)
|
||||
const [jsonContent, setJsonContent] = useState('')
|
||||
|
||||
// Debounce search to avoid excessive API calls
|
||||
const debouncedSearch = useDebounce(search, 300)
|
||||
|
||||
// SWR hook for fetching models
|
||||
const {
|
||||
data: modelsData,
|
||||
error,
|
||||
isLoading
|
||||
} = useModels({
|
||||
page: currentPage,
|
||||
limit: 20,
|
||||
search: debouncedSearch,
|
||||
capabilities: selectedCapabilities.length > 0 ? selectedCapabilities : undefined,
|
||||
providers: selectedProviders.length > 0 ? selectedProviders : undefined
|
||||
})
|
||||
|
||||
// SWR mutation for updating models
|
||||
const { trigger: updateModel, isMutating: isUpdating } = useUpdateModel()
|
||||
|
||||
// Extract data from SWR response
|
||||
const models = modelsData?.data || []
|
||||
const pagination = modelsData?.pagination || {
|
||||
page: 1,
|
||||
limit: 20,
|
||||
total: 0,
|
||||
totalPages: 0,
|
||||
hasNext: false,
|
||||
hasPrev: false
|
||||
}
|
||||
|
||||
const handleEdit = (model: Model) => {
|
||||
setEditingModel(model)
|
||||
setJsonContent(JSON.stringify(model, null, 2))
|
||||
}
|
||||
|
||||
const handleSave = async () => {
|
||||
if (!editingModel) return
|
||||
|
||||
try {
|
||||
// Validate JSON before sending
|
||||
const updatedModel = JSON.parse(jsonContent) as unknown
|
||||
|
||||
// Basic validation - the API will do thorough validation
|
||||
if (!updatedModel || typeof updatedModel !== 'object') {
|
||||
throw new Error('Invalid JSON format')
|
||||
}
|
||||
|
||||
// Use SWR mutation for optimistic update
|
||||
await updateModel({
|
||||
id: editingModel.id,
|
||||
data: updatedModel as Partial<Model>
|
||||
})
|
||||
|
||||
// Close dialog and reset form
|
||||
setEditingModel(null)
|
||||
setJsonContent('')
|
||||
} catch (error) {
|
||||
console.error('Error saving model:', error)
|
||||
// Error will be handled by SWR and displayed in UI
|
||||
}
|
||||
}
|
||||
|
||||
// Type-safe function to extract unique providers
|
||||
const getUniqueProviders = (): string[] => {
|
||||
return [
|
||||
...new Set(models.map((model) => model.owned_by).filter((provider): provider is string => Boolean(provider)))
|
||||
]
|
||||
}
|
||||
|
||||
return (
|
||||
<div className="container mx-auto p-6 space-y-6">
|
||||
<div className="flex items-center justify-between">
|
||||
<div>
|
||||
<h1 className="text-3xl font-bold">Catalog Review</h1>
|
||||
<p className="text-muted-foreground">Review and validate model configurations after migration</p>
|
||||
</div>
|
||||
<Navigation />
|
||||
</div>
|
||||
|
||||
<Card>
|
||||
<CardHeader>
|
||||
<CardTitle>Filters</CardTitle>
|
||||
<CardDescription>Filter models to review specific configurations</CardDescription>
|
||||
</CardHeader>
|
||||
<CardContent className="space-y-4">
|
||||
<div className="flex gap-4">
|
||||
<Input
|
||||
placeholder="Search models..."
|
||||
value={search}
|
||||
onChange={(e) => setSearch(e.target.value)}
|
||||
className="max-w-sm"
|
||||
/>
|
||||
</div>
|
||||
|
||||
<div>
|
||||
<label className="text-sm font-medium mb-2 block">Capabilities</label>
|
||||
<div className="flex flex-wrap gap-2">
|
||||
{CAPABILITIES.map((capability) => (
|
||||
<Badge
|
||||
key={capability}
|
||||
variant={selectedCapabilities.includes(capability) ? 'default' : 'outline'}
|
||||
className="cursor-pointer"
|
||||
onClick={() => {
|
||||
setSelectedCapabilities((prev) =>
|
||||
prev.includes(capability) ? prev.filter((c) => c !== capability) : [...prev, capability]
|
||||
)
|
||||
}}>
|
||||
{capability.replace('_', ' ')}
|
||||
</Badge>
|
||||
))}
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div>
|
||||
<label className="text-sm font-medium mb-2 block">Providers</label>
|
||||
<div className="flex flex-wrap gap-2">
|
||||
{getUniqueProviders().map((provider) => (
|
||||
<Badge
|
||||
key={provider}
|
||||
variant={selectedProviders.includes(provider) ? 'default' : 'outline'}
|
||||
className="cursor-pointer"
|
||||
onClick={() => {
|
||||
setSelectedProviders((prev) =>
|
||||
prev.includes(provider) ? prev.filter((p) => p !== provider) : [...prev, provider]
|
||||
)
|
||||
}}>
|
||||
{provider}
|
||||
</Badge>
|
||||
))}
|
||||
</div>
|
||||
</div>
|
||||
</CardContent>
|
||||
</Card>
|
||||
|
||||
{/* Error Display */}
|
||||
{error && (
|
||||
<Alert variant="destructive">
|
||||
<AlertDescription>{getErrorMessage(error)}</AlertDescription>
|
||||
</Alert>
|
||||
)}
|
||||
|
||||
<Card>
|
||||
<CardHeader>
|
||||
<CardTitle>Models ({pagination.total})</CardTitle>
|
||||
<CardDescription>Review migrated model configurations</CardDescription>
|
||||
</CardHeader>
|
||||
<CardContent>
|
||||
{isLoading ? (
|
||||
<div className="text-center py-8">
|
||||
<div className="animate-pulse">Loading models...</div>
|
||||
</div>
|
||||
) : (
|
||||
<>
|
||||
<Table>
|
||||
<TableHeader>
|
||||
<TableRow>
|
||||
<TableHead>ID</TableHead>
|
||||
<TableHead>Name</TableHead>
|
||||
<TableHead>Provider</TableHead>
|
||||
<TableHead>Capabilities</TableHead>
|
||||
<TableHead>Context Window</TableHead>
|
||||
<TableHead>Modalities</TableHead>
|
||||
<TableHead>Actions</TableHead>
|
||||
</TableRow>
|
||||
</TableHeader>
|
||||
<TableBody>
|
||||
{models.map((model) => (
|
||||
<TableRow key={model.id}>
|
||||
<TableCell className="font-mono text-sm">{model.id}</TableCell>
|
||||
<TableCell>{model.name || model.id}</TableCell>
|
||||
<TableCell>
|
||||
<Badge variant="outline">{model.owned_by}</Badge>
|
||||
</TableCell>
|
||||
<TableCell>
|
||||
<div className="flex flex-wrap gap-1 max-w-xs">
|
||||
{model.capabilities.slice(0, 3).map((cap) => (
|
||||
<Badge key={cap} variant="secondary" className="text-xs">
|
||||
{cap.replace('_', ' ')}
|
||||
</Badge>
|
||||
))}
|
||||
{model.capabilities.length > 3 && (
|
||||
<Badge variant="secondary" className="text-xs">
|
||||
+{model.capabilities.length - 3}
|
||||
</Badge>
|
||||
)}
|
||||
</div>
|
||||
</TableCell>
|
||||
<TableCell>{model.context_window.toLocaleString()}</TableCell>
|
||||
<TableCell>
|
||||
<div className="text-sm">
|
||||
<div>In: {model.input_modalities?.join(', ')}</div>
|
||||
<div>Out: {model.output_modalities?.join(', ')}</div>
|
||||
</div>
|
||||
</TableCell>
|
||||
<TableCell>
|
||||
<Dialog>
|
||||
<DialogTrigger asChild>
|
||||
<Button variant="outline" size="sm" onClick={() => handleEdit(model)}>
|
||||
Edit
|
||||
</Button>
|
||||
</DialogTrigger>
|
||||
<DialogContent className="max-w-4xl max-h-[80vh] overflow-auto">
|
||||
<DialogHeader>
|
||||
<DialogTitle>Edit Model Configuration</DialogTitle>
|
||||
<DialogDescription>
|
||||
Modify the JSON configuration for {model.name || model.id}
|
||||
</DialogDescription>
|
||||
</DialogHeader>
|
||||
<div className="space-y-4">
|
||||
<Textarea
|
||||
value={jsonContent}
|
||||
onChange={(e) => setJsonContent(e.target.value)}
|
||||
className="min-h-[400px] font-mono text-sm"
|
||||
/>
|
||||
<div className="flex gap-2 justify-end">
|
||||
<Button variant="outline" onClick={() => setEditingModel(null)}>
|
||||
Cancel
|
||||
</Button>
|
||||
<Button onClick={handleSave} disabled={isUpdating}>
|
||||
{isUpdating ? 'Saving...' : 'Save Changes'}
|
||||
</Button>
|
||||
</div>
|
||||
</div>
|
||||
</DialogContent>
|
||||
</Dialog>
|
||||
</TableCell>
|
||||
</TableRow>
|
||||
))}
|
||||
</TableBody>
|
||||
</Table>
|
||||
|
||||
<Separator className="my-4" />
|
||||
|
||||
<div className="flex items-center justify-between">
|
||||
<div className="text-sm text-muted-foreground">
|
||||
Showing {(pagination.page - 1) * pagination.limit + 1} to{' '}
|
||||
{Math.min(pagination.page * pagination.limit, pagination.total)} of {pagination.total} models
|
||||
</div>
|
||||
<SimplePagination
|
||||
currentPage={pagination.page}
|
||||
totalPages={pagination.totalPages}
|
||||
onPageChange={setCurrentPage}
|
||||
/>
|
||||
</div>
|
||||
</>
|
||||
)}
|
||||
</CardContent>
|
||||
</Card>
|
||||
</div>
|
||||
)
|
||||
}
|
||||
323
packages/catalog/web/app/providers/page.tsx
Normal file
323
packages/catalog/web/app/providers/page.tsx
Normal file
@@ -0,0 +1,323 @@
|
||||
'use client'
|
||||
|
||||
import { useState } from 'react'
|
||||
|
||||
import { Navigation } from '@/components/navigation'
|
||||
import { Alert, AlertDescription } from '@/components/ui/alert'
|
||||
import { Badge } from '@/components/ui/badge'
|
||||
import { Button } from '@/components/ui/button'
|
||||
import { Card, CardContent, CardDescription, CardHeader, CardTitle } from '@/components/ui/card'
|
||||
import {
|
||||
Dialog,
|
||||
DialogContent,
|
||||
DialogDescription,
|
||||
DialogHeader,
|
||||
DialogTitle,
|
||||
DialogTrigger
|
||||
} from '@/components/ui/dialog'
|
||||
import { Input } from '@/components/ui/input'
|
||||
import { Separator } from '@/components/ui/separator'
|
||||
import { Table, TableBody, TableCell, TableHead, TableHeader, TableRow } from '@/components/ui/table'
|
||||
import { Textarea } from '@/components/ui/textarea'
|
||||
// Import SWR hooks and utilities
|
||||
import { getErrorMessage, useDebounce, useProviders, useUpdateProvider } from '@/lib/api-client'
|
||||
import type { Provider } from '@/lib/catalog-types'
|
||||
|
||||
// Simple Pagination Component
|
||||
function SimplePagination({
|
||||
currentPage,
|
||||
totalPages,
|
||||
onPageChange
|
||||
}: {
|
||||
currentPage: number
|
||||
totalPages: number
|
||||
onPageChange: (page: number) => void
|
||||
}) {
|
||||
const pages = Array.from({ length: Math.min(5, totalPages) }, (_, i) => {
|
||||
if (totalPages <= 5) return i + 1
|
||||
if (currentPage <= 3) return i + 1
|
||||
if (currentPage >= totalPages - 2) return totalPages - 4 + i
|
||||
return currentPage - 2 + i
|
||||
})
|
||||
|
||||
return (
|
||||
<div className="flex items-center gap-2">
|
||||
<Button variant="outline" size="sm" onClick={() => onPageChange(currentPage - 1)} disabled={currentPage <= 1}>
|
||||
Previous
|
||||
</Button>
|
||||
{pages.map((page) => (
|
||||
<Button
|
||||
key={page}
|
||||
variant={currentPage === page ? 'default' : 'outline'}
|
||||
size="sm"
|
||||
onClick={() => onPageChange(page)}>
|
||||
{page}
|
||||
</Button>
|
||||
))}
|
||||
<Button
|
||||
variant="outline"
|
||||
size="sm"
|
||||
onClick={() => onPageChange(currentPage + 1)}
|
||||
disabled={currentPage >= totalPages}>
|
||||
Next
|
||||
</Button>
|
||||
</div>
|
||||
)
|
||||
}
|
||||
|
||||
export default function ProvidersPage() {
|
||||
// Form state
|
||||
const [search, setSearch] = useState('')
|
||||
const [currentPage, setCurrentPage] = useState(1)
|
||||
const [editingProvider, setEditingProvider] = useState<Provider | null>(null)
|
||||
const [jsonContent, setJsonContent] = useState('')
|
||||
|
||||
// Debounce search to avoid excessive API calls
|
||||
const debouncedSearch = useDebounce(search, 300)
|
||||
|
||||
// SWR hook for fetching providers
|
||||
const {
|
||||
data: providersData,
|
||||
error,
|
||||
isLoading,
|
||||
mutate: refetchProviders
|
||||
} = useProviders({
|
||||
page: currentPage,
|
||||
limit: 20,
|
||||
search: debouncedSearch
|
||||
})
|
||||
|
||||
// SWR mutation for updating providers
|
||||
const { trigger: updateProvider, isMutating: isUpdating } = useUpdateProvider()
|
||||
|
||||
// Extract data from SWR response
|
||||
const providers = providersData?.data || []
|
||||
const pagination = providersData?.pagination || {
|
||||
page: 1,
|
||||
limit: 20,
|
||||
total: 0,
|
||||
totalPages: 0,
|
||||
hasNext: false,
|
||||
hasPrev: false
|
||||
}
|
||||
|
||||
const handleEdit = (provider: Provider) => {
|
||||
setEditingProvider(provider)
|
||||
setJsonContent(JSON.stringify(provider, null, 2))
|
||||
}
|
||||
|
||||
const handleSave = async () => {
|
||||
if (!editingProvider) return
|
||||
|
||||
try {
|
||||
// Validate JSON before sending
|
||||
const updatedProvider = JSON.parse(jsonContent) as unknown
|
||||
|
||||
// Basic validation - the API will do thorough validation
|
||||
if (!updatedProvider || typeof updatedProvider !== 'object') {
|
||||
throw new Error('Invalid JSON format')
|
||||
}
|
||||
|
||||
// Use SWR mutation for optimistic update
|
||||
await updateProvider({
|
||||
id: editingProvider.id,
|
||||
data: updatedProvider as Partial<Provider>
|
||||
})
|
||||
|
||||
// Close dialog and reset form
|
||||
setEditingProvider(null)
|
||||
setJsonContent('')
|
||||
} catch (error) {
|
||||
console.error('Error saving provider:', error)
|
||||
// Error will be handled by SWR and displayed in UI
|
||||
}
|
||||
}
|
||||
|
||||
// Type-safe function to extract provider capabilities
|
||||
const getCapabilities = (behaviors: Record<string, unknown>): string[] => {
|
||||
return Object.entries(behaviors)
|
||||
.filter(([_, value]) => value === true)
|
||||
.map(([key, _]) => key.replace(/_/g, ' ').replace(/\b\w/g, (letter) => letter.toUpperCase()))
|
||||
}
|
||||
|
||||
return (
|
||||
<div className="container mx-auto p-6 space-y-6">
|
||||
<div className="flex items-center justify-between">
|
||||
<div>
|
||||
<h1 className="text-3xl font-bold">Provider Management</h1>
|
||||
<p className="text-muted-foreground">Review and validate provider configurations</p>
|
||||
</div>
|
||||
<Navigation />
|
||||
</div>
|
||||
|
||||
<Card>
|
||||
<CardHeader>
|
||||
<CardTitle>Filters</CardTitle>
|
||||
<CardDescription>Filter providers to review specific configurations</CardDescription>
|
||||
</CardHeader>
|
||||
<CardContent className="space-y-4">
|
||||
<div className="flex gap-4">
|
||||
<Input
|
||||
placeholder="Search providers..."
|
||||
value={search}
|
||||
onChange={(e) => setSearch(e.target.value)}
|
||||
className="max-w-sm"
|
||||
/>
|
||||
</div>
|
||||
</CardContent>
|
||||
</Card>
|
||||
|
||||
{/* Error Display */}
|
||||
{error && (
|
||||
<Alert variant="destructive">
|
||||
<AlertDescription>{getErrorMessage(error)}</AlertDescription>
|
||||
</Alert>
|
||||
)}
|
||||
|
||||
<Card>
|
||||
<CardHeader>
|
||||
<CardTitle>Providers ({pagination.total})</CardTitle>
|
||||
<CardDescription>Review provider configurations and capabilities</CardDescription>
|
||||
</CardHeader>
|
||||
<CardContent>
|
||||
{isLoading ? (
|
||||
<div className="text-center py-8">
|
||||
<div className="animate-pulse">Loading providers...</div>
|
||||
</div>
|
||||
) : (
|
||||
<>
|
||||
<Table>
|
||||
<TableHeader>
|
||||
<TableRow>
|
||||
<TableHead>ID</TableHead>
|
||||
<TableHead>Name</TableHead>
|
||||
<TableHead>Authentication</TableHead>
|
||||
<TableHead>Pricing Model</TableHead>
|
||||
<TableHead>Endpoints</TableHead>
|
||||
<TableHead>Capabilities</TableHead>
|
||||
<TableHead>Status</TableHead>
|
||||
<TableHead>Actions</TableHead>
|
||||
</TableRow>
|
||||
</TableHeader>
|
||||
<TableBody>
|
||||
{providers.map((provider) => (
|
||||
<TableRow key={provider.id}>
|
||||
<TableCell className="font-mono text-sm">{provider.id}</TableCell>
|
||||
<TableCell>
|
||||
<div>
|
||||
<div className="font-medium">{provider.name}</div>
|
||||
{provider.description && (
|
||||
<div className="text-sm text-muted-foreground">{provider.description}</div>
|
||||
)}
|
||||
</div>
|
||||
</TableCell>
|
||||
<TableCell>
|
||||
<Badge variant="outline">{provider.authentication}</Badge>
|
||||
</TableCell>
|
||||
<TableCell>
|
||||
<Badge variant="secondary">{provider.pricing_model}</Badge>
|
||||
</TableCell>
|
||||
<TableCell>
|
||||
<div className="flex flex-wrap gap-1 max-w-xs">
|
||||
{provider.supported_endpoints.slice(0, 2).map((endpoint) => (
|
||||
<Badge key={endpoint} variant="outline" className="text-xs">
|
||||
{endpoint}
|
||||
</Badge>
|
||||
))}
|
||||
{provider.supported_endpoints.length > 2 && (
|
||||
<Badge variant="outline" className="text-xs">
|
||||
+{provider.supported_endpoints.length - 2}
|
||||
</Badge>
|
||||
)}
|
||||
</div>
|
||||
</TableCell>
|
||||
<TableCell>
|
||||
<div className="flex flex-wrap gap-1 max-w-xs">
|
||||
{getCapabilities(provider.behaviors)
|
||||
.slice(0, 2)
|
||||
.map((capability) => (
|
||||
<Badge key={capability} variant="secondary" className="text-xs">
|
||||
{capability}
|
||||
</Badge>
|
||||
))}
|
||||
{getCapabilities(provider.behaviors).length > 2 && (
|
||||
<Badge variant="secondary" className="text-xs">
|
||||
+{getCapabilities(provider.behaviors).length - 2}
|
||||
</Badge>
|
||||
)}
|
||||
</div>
|
||||
</TableCell>
|
||||
<TableCell>
|
||||
<div className="space-y-1">
|
||||
{provider.deprecated && (
|
||||
<Badge variant="destructive" className="text-xs">
|
||||
Deprecated
|
||||
</Badge>
|
||||
)}
|
||||
{provider.maintenance_mode && (
|
||||
<Badge variant="outline" className="text-xs">
|
||||
Maintenance
|
||||
</Badge>
|
||||
)}
|
||||
{!provider.deprecated && !provider.maintenance_mode && (
|
||||
<Badge variant="default" className="text-xs">
|
||||
Active
|
||||
</Badge>
|
||||
)}
|
||||
</div>
|
||||
</TableCell>
|
||||
<TableCell>
|
||||
<Dialog>
|
||||
<DialogTrigger asChild>
|
||||
<Button variant="outline" size="sm" onClick={() => handleEdit(provider)}>
|
||||
Edit
|
||||
</Button>
|
||||
</DialogTrigger>
|
||||
<DialogContent className="max-w-4xl max-h-[80vh] overflow-auto">
|
||||
<DialogHeader>
|
||||
<DialogTitle>Edit Provider Configuration</DialogTitle>
|
||||
<DialogDescription>Modify the JSON configuration for {provider.name}</DialogDescription>
|
||||
</DialogHeader>
|
||||
<div className="space-y-4">
|
||||
<Textarea
|
||||
value={jsonContent}
|
||||
onChange={(e) => setJsonContent(e.target.value)}
|
||||
className="min-h-[400px] font-mono text-sm"
|
||||
/>
|
||||
<div className="flex gap-2 justify-end">
|
||||
<Button variant="outline" onClick={() => setEditingProvider(null)}>
|
||||
Cancel
|
||||
</Button>
|
||||
<Button onClick={handleSave} disabled={isUpdating}>
|
||||
{isUpdating ? 'Saving...' : 'Save Changes'}
|
||||
</Button>
|
||||
</div>
|
||||
</div>
|
||||
</DialogContent>
|
||||
</Dialog>
|
||||
</TableCell>
|
||||
</TableRow>
|
||||
))}
|
||||
</TableBody>
|
||||
</Table>
|
||||
|
||||
<Separator className="my-4" />
|
||||
|
||||
<div className="flex items-center justify-between">
|
||||
<div className="text-sm text-muted-foreground">
|
||||
Showing {(pagination.page - 1) * pagination.limit + 1} to{' '}
|
||||
{Math.min(pagination.page * pagination.limit, pagination.total)} of {pagination.total} providers
|
||||
</div>
|
||||
<SimplePagination
|
||||
currentPage={pagination.page}
|
||||
totalPages={pagination.totalPages}
|
||||
onPageChange={setCurrentPage}
|
||||
/>
|
||||
</div>
|
||||
</>
|
||||
)}
|
||||
</CardContent>
|
||||
</Card>
|
||||
</div>
|
||||
)
|
||||
}
|
||||
20
packages/catalog/web/components.json
Normal file
20
packages/catalog/web/components.json
Normal file
@@ -0,0 +1,20 @@
|
||||
{
|
||||
"$schema": "https://ui.shadcn.com/schema.json",
|
||||
"style": "new-york",
|
||||
"rsc": true,
|
||||
"tsx": true,
|
||||
"tailwind": {
|
||||
"config": "tailwind.config.ts",
|
||||
"css": "app/globals.css",
|
||||
"baseColor": "slate",
|
||||
"cssVariables": true,
|
||||
"prefix": ""
|
||||
},
|
||||
"aliases": {
|
||||
"components": "@/components",
|
||||
"utils": "@/lib/utils",
|
||||
"ui": "@/components/ui",
|
||||
"lib": "@/lib",
|
||||
"hooks": "@/hooks"
|
||||
}
|
||||
}
|
||||
32
packages/catalog/web/components/navigation.tsx
Normal file
32
packages/catalog/web/components/navigation.tsx
Normal file
@@ -0,0 +1,32 @@
|
||||
'use client'
|
||||
|
||||
import Link from 'next/link'
|
||||
import { usePathname } from 'next/navigation'
|
||||
|
||||
import { cn } from '@/lib/utils'
|
||||
|
||||
const navigation = [
|
||||
{ name: 'Models', href: '/' },
|
||||
{ name: 'Providers', href: '/providers' },
|
||||
{ name: 'Overrides', href: '/overrides' }
|
||||
]
|
||||
|
||||
export function Navigation() {
|
||||
const pathname = usePathname()
|
||||
|
||||
return (
|
||||
<nav className="flex space-x-8">
|
||||
{navigation.map((item) => (
|
||||
<Link
|
||||
key={item.name}
|
||||
href={item.href}
|
||||
className={cn(
|
||||
'text-sm font-medium transition-colors hover:text-primary',
|
||||
pathname === item.href ? 'text-foreground' : 'text-muted-foreground'
|
||||
)}>
|
||||
{item.name}
|
||||
</Link>
|
||||
))}
|
||||
</nav>
|
||||
)
|
||||
}
|
||||
59
packages/catalog/web/components/ui/alert.tsx
Normal file
59
packages/catalog/web/components/ui/alert.tsx
Normal file
@@ -0,0 +1,59 @@
|
||||
import * as React from "react"
|
||||
import { cva, type VariantProps } from "class-variance-authority"
|
||||
|
||||
import { cn } from "@/lib/utils"
|
||||
|
||||
const alertVariants = cva(
|
||||
"relative w-full rounded-lg border px-4 py-3 text-sm [&>svg+div]:translate-y-[-3px] [&>svg]:absolute [&>svg]:left-4 [&>svg]:top-4 [&>svg]:text-foreground [&>svg~*]:pl-7",
|
||||
{
|
||||
variants: {
|
||||
variant: {
|
||||
default: "bg-background text-foreground",
|
||||
destructive:
|
||||
"border-destructive/50 text-destructive dark:border-destructive [&>svg]:text-destructive",
|
||||
},
|
||||
},
|
||||
defaultVariants: {
|
||||
variant: "default",
|
||||
},
|
||||
}
|
||||
)
|
||||
|
||||
const Alert = React.forwardRef<
|
||||
HTMLDivElement,
|
||||
React.HTMLAttributes<HTMLDivElement> & VariantProps<typeof alertVariants>
|
||||
>(({ className, variant, ...props }, ref) => (
|
||||
<div
|
||||
ref={ref}
|
||||
role="alert"
|
||||
className={cn(alertVariants({ variant }), className)}
|
||||
{...props}
|
||||
/>
|
||||
))
|
||||
Alert.displayName = "Alert"
|
||||
|
||||
const AlertTitle = React.forwardRef<
|
||||
HTMLParagraphElement,
|
||||
React.HTMLAttributes<HTMLHeadingElement>
|
||||
>(({ className, ...props }, ref) => (
|
||||
<h5
|
||||
ref={ref}
|
||||
className={cn("mb-1 font-medium leading-none tracking-tight", className)}
|
||||
{...props}
|
||||
/>
|
||||
))
|
||||
AlertTitle.displayName = "AlertTitle"
|
||||
|
||||
const AlertDescription = React.forwardRef<
|
||||
HTMLParagraphElement,
|
||||
React.HTMLAttributes<HTMLParagraphElement>
|
||||
>(({ className, ...props }, ref) => (
|
||||
<div
|
||||
ref={ref}
|
||||
className={cn("text-sm [&_p]:leading-relaxed", className)}
|
||||
{...props}
|
||||
/>
|
||||
))
|
||||
AlertDescription.displayName = "AlertDescription"
|
||||
|
||||
export { Alert, AlertTitle, AlertDescription }
|
||||
29
packages/catalog/web/components/ui/badge.tsx
Normal file
29
packages/catalog/web/components/ui/badge.tsx
Normal file
@@ -0,0 +1,29 @@
|
||||
import { cva, type VariantProps } from 'class-variance-authority'
|
||||
import * as React from 'react'
|
||||
|
||||
import { cn } from '@/lib/utils'
|
||||
|
||||
const badgeVariants = cva(
|
||||
'inline-flex items-center rounded-md border px-2.5 py-0.5 text-xs font-semibold transition-colors focus:outline-none focus:ring-2 focus:ring-ring focus:ring-offset-2',
|
||||
{
|
||||
variants: {
|
||||
variant: {
|
||||
default: 'border-transparent bg-primary text-primary-foreground shadow hover:bg-primary/80',
|
||||
secondary: 'border-transparent bg-secondary text-secondary-foreground hover:bg-secondary/80',
|
||||
destructive: 'border-transparent bg-destructive text-destructive-foreground shadow hover:bg-destructive/80',
|
||||
outline: 'text-foreground'
|
||||
}
|
||||
},
|
||||
defaultVariants: {
|
||||
variant: 'default'
|
||||
}
|
||||
}
|
||||
)
|
||||
|
||||
export interface BadgeProps extends React.HTMLAttributes<HTMLDivElement>, VariantProps<typeof badgeVariants> {}
|
||||
|
||||
function Badge({ className, variant, ...props }: BadgeProps) {
|
||||
return <div className={cn(badgeVariants({ variant }), className)} {...props} />
|
||||
}
|
||||
|
||||
export { Badge, badgeVariants }
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user