@fastgpt-plugin/sdk-client 1.1.0 → 1.2.0-alpha.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +35 -0
- package/README.en.md +40 -10
- package/README.md +41 -11
- package/dist/index.d.ts +137 -47
- package/dist/index.js +10 -10
- package/dist/index.js.map +1 -1
- package/package.json +7 -7
package/LICENSE
ADDED
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# FastGPT Open Source License
|
|
2
|
+
|
|
3
|
+
The FastGPT is licensed under the Apache License 2.0, with the following additional conditions:
|
|
4
|
+
|
|
5
|
+
1. FastGPT is permitted to be used for commercialization. You can use FastGPT as a "backend-as-a-service" for your other applications, or delivering it to enterprises as an application development platform. However, when the following conditions are met, you must contact the producer to obtain a commercial license:
|
|
6
|
+
|
|
7
|
+
a. Multi-tenant SaaS service: Unless explicitly authorized by FastGPT in writing, you may not use the FastGPT.AI source code to operate a multi-tenant SaaS service that is similar to the FastGPT.
|
|
8
|
+
b. LOGO and copyright information: In the process of using FastGPT, you may not remove or modify the LOGO or copyright information in the FastGPT console.
|
|
9
|
+
|
|
10
|
+
Please contact dennis@sealos.io by email to inquire about licensing matters.
|
|
11
|
+
|
|
12
|
+
2. As a contributor, you should agree that your contributed code:
|
|
13
|
+
|
|
14
|
+
a. The producer can adjust the open-source agreement to be more strict or relaxed.
|
|
15
|
+
b. Can be used for commercial purposes, such as FastGPT's cloud business.
|
|
16
|
+
|
|
17
|
+
Apart from this, all other rights and restrictions follow the Apache License 2.0. If you need more detailed information, you can refer to the full version of Apache License 2.0.
|
|
18
|
+
|
|
19
|
+
The interactive design of this product is protected by appearance patent.
|
|
20
|
+
|
|
21
|
+
© 2023 Sealos.
|
|
22
|
+
|
|
23
|
+
---
|
|
24
|
+
|
|
25
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
26
|
+
you may not use this file except in compliance with the License.
|
|
27
|
+
You may obtain a copy of the License at
|
|
28
|
+
|
|
29
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
30
|
+
|
|
31
|
+
Unless required by applicable law or agreed to in writing, software
|
|
32
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
33
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
34
|
+
See the License for the specific language governing permissions and
|
|
35
|
+
limitations under the License.
|
package/README.en.md
CHANGED
|
@@ -2,22 +2,52 @@
|
|
|
2
2
|
|
|
3
3
|
Language: [简体中文](./README.md) | [English](./README.en.md)
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
The TypeScript client wraps the FastGPT Plugin service API. `FastGPTPluginClient` passes through service responses; it does not select display languages for callers.
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
```ts
|
|
8
|
+
import { FastGPTPluginClient } from '@fastgpt-plugin/sdk-client';
|
|
9
|
+
|
|
10
|
+
const client = new FastGPTPluginClient({
|
|
11
|
+
baseUrl: 'https://plugin.example.com',
|
|
12
|
+
token: process.env.FASTGPT_PLUGIN_TOKEN
|
|
13
|
+
});
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## Workflow Templates
|
|
17
|
+
|
|
18
|
+
`listWorkflows()` takes no locale parameter and does not translate templates; fields such as `name` and `intro` pass through as strings. Workflow node configuration remains open-ended.
|
|
8
19
|
|
|
9
20
|
```ts
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
limit: number;
|
|
14
|
-
total: number;
|
|
15
|
-
};
|
|
21
|
+
const templates = await client.listWorkflows();
|
|
22
|
+
const templateName = templates[0]?.name;
|
|
23
|
+
const firstInputLabel = templates[0]?.workflow.nodes[0]?.inputs?.[0]?.label;
|
|
16
24
|
```
|
|
17
25
|
|
|
18
|
-
|
|
26
|
+
## Localized Plugin README URLs
|
|
27
|
+
|
|
28
|
+
Plugin data preserves both the compatibility field `readmeUrl` and a `readmeUrls` map for README variants that actually exist. A UI should first select the current locale, then fall back to Simplified Chinese and English. If no mapped URL is available, use the legacy `readmeUrl` as a final fallback. The SDK does not parse README content or choose a locale.
|
|
29
|
+
|
|
30
|
+
```ts
|
|
31
|
+
type Locale = 'en' | 'zh-CN' | 'zh-Hant';
|
|
32
|
+
|
|
33
|
+
const plugins = await client.listPlugins();
|
|
34
|
+
const plugin = plugins[0];
|
|
35
|
+
const locale: Locale = 'zh-Hant';
|
|
36
|
+
const readmeUrl = plugin
|
|
37
|
+
? plugin.readmeUrls?.[locale] ??
|
|
38
|
+
plugin.readmeUrls?.['zh-CN'] ??
|
|
39
|
+
plugin.readmeUrls?.en ??
|
|
40
|
+
plugin.readmeUrl
|
|
41
|
+
: undefined;
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
`readmeUrls` contains only the locales supplied in the package. If a root `README.md` exists, the server points `readmeUrl` to it; otherwise it selects the first available variant in `zh-CN`, `en`, then `zh-Hant` order. The locale-selection example above is for the display client; older clients can continue reading only `readmeUrl`.
|
|
45
|
+
|
|
46
|
+
`PluginListType` is an array of plugin list items. `PluginListItemType` and `PluginSourceType` are also exported for handling the plugin `source` field.
|
|
47
|
+
|
|
48
|
+
## Plugin Service Features
|
|
19
49
|
|
|
20
|
-
`getPluginServiceFeatures()` returns the enabled Plugin service
|
|
50
|
+
`getPluginServiceFeatures()` returns the capabilities enabled on the current Plugin service:
|
|
21
51
|
|
|
22
52
|
```ts
|
|
23
53
|
const features = await client.getPluginServiceFeatures();
|
package/README.md
CHANGED
|
@@ -1,23 +1,53 @@
|
|
|
1
|
-
# FastGPT-plugin SDK
|
|
1
|
+
# FastGPT-plugin SDK Client
|
|
2
2
|
|
|
3
3
|
语言：[简体中文](./README.md) | [English](./README.en.md)
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
TypeScript 客户端封装 FastGPT Plugin 服务 API。`FastGPTPluginClient` 的方法会透传服务端响应；SDK 不替调用方选择展示语言。
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
```ts
|
|
8
|
+
import { FastGPTPluginClient } from '@fastgpt-plugin/sdk-client';
|
|
9
|
+
|
|
10
|
+
const client = new FastGPTPluginClient({
|
|
11
|
+
baseUrl: 'https://plugin.example.com',
|
|
12
|
+
token: process.env.FASTGPT_PLUGIN_TOKEN
|
|
13
|
+
});
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## 工作流模板
|
|
17
|
+
|
|
18
|
+
`listWorkflows()` 不接收 locale 参数，也不会对工作流模板进行翻译；模板 `name`、`intro` 等字段按原字符串透传。工作流节点配置保持开放结构。
|
|
8
19
|
|
|
9
20
|
```ts
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
limit: number;
|
|
14
|
-
total: number;
|
|
15
|
-
};
|
|
21
|
+
const templates = await client.listWorkflows();
|
|
22
|
+
const templateName = templates[0]?.name;
|
|
23
|
+
const firstInputLabel = templates[0]?.workflow.nodes[0]?.inputs?.[0]?.label;
|
|
16
24
|
```
|
|
17
25
|
|
|
18
|
-
|
|
26
|
+
## 多语言插件 README URL
|
|
27
|
+
|
|
28
|
+
插件信息会同时保留兼容字段 `readmeUrl` 和实际存在的 README 语言映射 `readmeUrls`。UI 应先按当前语言查映射，然后回退到简体中文、英文；若新映射没有可用地址，最后可使用旧 `readmeUrl`。SDK 不解析 README 内容或做语言选择。
|
|
29
|
+
|
|
30
|
+
```ts
|
|
31
|
+
type Locale = 'en' | 'zh-CN' | 'zh-Hant';
|
|
32
|
+
|
|
33
|
+
const plugins = await client.listPlugins();
|
|
34
|
+
const plugin = plugins[0];
|
|
35
|
+
const locale: Locale = 'zh-Hant';
|
|
36
|
+
const readmeUrl = plugin
|
|
37
|
+
? plugin.readmeUrls?.[locale] ??
|
|
38
|
+
plugin.readmeUrls?.['zh-CN'] ??
|
|
39
|
+
plugin.readmeUrls?.en ??
|
|
40
|
+
plugin.readmeUrl
|
|
41
|
+
: undefined;
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
`readmeUrls` 只包含包内实际提供的语言版本。服务端在根目录存在 `README.md` 时让 `readmeUrl` 指向它；否则按 `zh-CN`、`en`、`zh-Hant` 顺序选择可用变体。上述 UI 回退逻辑适用于展示端的语言选择；旧客户端仍可只读取 `readmeUrl`。
|
|
45
|
+
|
|
46
|
+
`PluginListType` 是插件列表项数组；`PluginListItemType` 和 `PluginSourceType` 也从客户端 SDK 导出，供调用方处理插件来源字段。
|
|
47
|
+
|
|
48
|
+
## Plugin 服务能力
|
|
19
49
|
|
|
20
|
-
`getPluginServiceFeatures()`
|
|
50
|
+
`getPluginServiceFeatures()` 返回当前 Plugin 服务已启用的能力：
|
|
21
51
|
|
|
22
52
|
```ts
|
|
23
53
|
const features = await client.getPluginServiceFeatures();
|
package/dist/index.d.ts
CHANGED
|
@@ -56,6 +56,7 @@ declare const ModelListDTOSchema: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObjec
|
|
|
56
56
|
maxToken: z.ZodNumber;
|
|
57
57
|
weight: z.ZodOptional<z.ZodNumber>;
|
|
58
58
|
hidden: z.ZodOptional<z.ZodBoolean>;
|
|
59
|
+
vision: z.ZodOptional<z.ZodBoolean>;
|
|
59
60
|
normalization: z.ZodOptional<z.ZodBoolean>;
|
|
60
61
|
defaultConfig: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
|
|
61
62
|
dbConfig: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
|
|
@@ -104,6 +105,7 @@ declare const ModelProviderItemDTOSchema: z.ZodObject<{
|
|
|
104
105
|
"zh-Hant": z.ZodString;
|
|
105
106
|
}, z.core.$strip>;
|
|
106
107
|
avatar: z.ZodString;
|
|
108
|
+
website: z.ZodString;
|
|
107
109
|
}, z.core.$strip>;
|
|
108
110
|
declare const AIProxyChannelItemDTOSchema: z.ZodObject<{
|
|
109
111
|
channelId: z.ZodNumber;
|
|
@@ -123,6 +125,7 @@ declare const ModelProviderListDTOSchema: z.ZodObject<{
|
|
|
123
125
|
"zh-Hant": z.ZodString;
|
|
124
126
|
}, z.core.$strip>;
|
|
125
127
|
avatar: z.ZodString;
|
|
128
|
+
website: z.ZodString;
|
|
126
129
|
}, z.core.$strip>>;
|
|
127
130
|
aiproxyChannels: z.ZodArray<z.ZodObject<{
|
|
128
131
|
channelId: z.ZodNumber;
|
|
@@ -154,6 +157,11 @@ declare const PluginBaseDTOSchema: z.ZodObject<{
|
|
|
154
157
|
icon: z.ZodString;
|
|
155
158
|
tutorialUrl: z.ZodOptional<z.ZodURL>;
|
|
156
159
|
readmeUrl: z.ZodOptional<z.ZodURL>;
|
|
160
|
+
readmeUrls: z.ZodOptional<z.ZodRecord<z.ZodEnum<{
|
|
161
|
+
en: "en";
|
|
162
|
+
"zh-CN": "zh-CN";
|
|
163
|
+
"zh-Hant": "zh-Hant";
|
|
164
|
+
}> & z.core.$partial, z.ZodURL>>;
|
|
157
165
|
repoUrl: z.ZodOptional<z.ZodURL>;
|
|
158
166
|
permission: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
159
167
|
description: z.ZodOptional<z.ZodObject<{
|
|
@@ -169,12 +177,12 @@ declare const PluginBaseDTOSchema: z.ZodObject<{
|
|
|
169
177
|
}, z.core.$strip>>;
|
|
170
178
|
}, z.core.$strip>;
|
|
171
179
|
declare const PluginListItemDTOSchema: z.ZodObject<{
|
|
172
|
-
type: z.ZodString;
|
|
173
180
|
name: z.ZodObject<{
|
|
174
181
|
en: z.ZodString;
|
|
175
182
|
"zh-CN": z.ZodString;
|
|
176
183
|
"zh-Hant": z.ZodOptional<z.ZodString>;
|
|
177
184
|
}, z.core.$strip>;
|
|
185
|
+
type: z.ZodString;
|
|
178
186
|
description: z.ZodOptional<z.ZodObject<{
|
|
179
187
|
en: z.ZodString;
|
|
180
188
|
"zh-CN": z.ZodString;
|
|
@@ -188,16 +196,21 @@ declare const PluginListItemDTOSchema: z.ZodObject<{
|
|
|
188
196
|
icon: z.ZodString;
|
|
189
197
|
tutorialUrl: z.ZodOptional<z.ZodURL>;
|
|
190
198
|
readmeUrl: z.ZodOptional<z.ZodURL>;
|
|
199
|
+
readmeUrls: z.ZodOptional<z.ZodRecord<z.ZodEnum<{
|
|
200
|
+
en: "en";
|
|
201
|
+
"zh-CN": "zh-CN";
|
|
202
|
+
"zh-Hant": "zh-Hant";
|
|
203
|
+
}> & z.core.$partial, z.ZodURL>>;
|
|
191
204
|
tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
192
205
|
source: z.ZodString;
|
|
193
206
|
}, z.core.$strip>;
|
|
194
207
|
declare const PluginListDTOSchema: z.ZodArray<z.ZodObject<{
|
|
195
|
-
type: z.ZodString;
|
|
196
208
|
name: z.ZodObject<{
|
|
197
209
|
en: z.ZodString;
|
|
198
210
|
"zh-CN": z.ZodString;
|
|
199
211
|
"zh-Hant": z.ZodOptional<z.ZodString>;
|
|
200
212
|
}, z.core.$strip>;
|
|
213
|
+
type: z.ZodString;
|
|
201
214
|
description: z.ZodOptional<z.ZodObject<{
|
|
202
215
|
en: z.ZodString;
|
|
203
216
|
"zh-CN": z.ZodString;
|
|
@@ -211,6 +224,11 @@ declare const PluginListDTOSchema: z.ZodArray<z.ZodObject<{
|
|
|
211
224
|
icon: z.ZodString;
|
|
212
225
|
tutorialUrl: z.ZodOptional<z.ZodURL>;
|
|
213
226
|
readmeUrl: z.ZodOptional<z.ZodURL>;
|
|
227
|
+
readmeUrls: z.ZodOptional<z.ZodRecord<z.ZodEnum<{
|
|
228
|
+
en: "en";
|
|
229
|
+
"zh-CN": "zh-CN";
|
|
230
|
+
"zh-Hant": "zh-Hant";
|
|
231
|
+
}> & z.core.$partial, z.ZodURL>>;
|
|
214
232
|
tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
215
233
|
source: z.ZodString;
|
|
216
234
|
}, z.core.$strip>>;
|
|
@@ -237,6 +255,11 @@ declare const PluginUploadResponseDTOSchema: z.ZodObject<{
|
|
|
237
255
|
icon: z.ZodString;
|
|
238
256
|
tutorialUrl: z.ZodOptional<z.ZodURL>;
|
|
239
257
|
readmeUrl: z.ZodOptional<z.ZodURL>;
|
|
258
|
+
readmeUrls: z.ZodOptional<z.ZodRecord<z.ZodEnum<{
|
|
259
|
+
en: "en";
|
|
260
|
+
"zh-CN": "zh-CN";
|
|
261
|
+
"zh-Hant": "zh-Hant";
|
|
262
|
+
}> & z.core.$partial, z.ZodURL>>;
|
|
240
263
|
repoUrl: z.ZodOptional<z.ZodURL>;
|
|
241
264
|
permission: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
242
265
|
description: z.ZodOptional<z.ZodObject<{
|
|
@@ -439,12 +462,12 @@ declare const PluginDebugSessionStatusResponseDTOSchema: z$1.ZodObject<{
|
|
|
439
462
|
enabled: z$1.ZodBoolean;
|
|
440
463
|
keyId: z$1.ZodOptional<z$1.ZodString>;
|
|
441
464
|
plugins: z$1.ZodArray<z$1.ZodObject<{
|
|
442
|
-
type: z$1.ZodString;
|
|
443
465
|
name: z$1.ZodObject<{
|
|
444
466
|
en: z$1.ZodString;
|
|
445
467
|
"zh-CN": z$1.ZodString;
|
|
446
468
|
"zh-Hant": z$1.ZodOptional<z$1.ZodString>;
|
|
447
469
|
}, z$1.core.$strip>;
|
|
470
|
+
type: z$1.ZodString;
|
|
448
471
|
description: z$1.ZodOptional<z$1.ZodObject<{
|
|
449
472
|
en: z$1.ZodString;
|
|
450
473
|
"zh-CN": z$1.ZodString;
|
|
@@ -458,6 +481,11 @@ declare const PluginDebugSessionStatusResponseDTOSchema: z$1.ZodObject<{
|
|
|
458
481
|
icon: z$1.ZodString;
|
|
459
482
|
tutorialUrl: z$1.ZodOptional<z$1.ZodURL>;
|
|
460
483
|
readmeUrl: z$1.ZodOptional<z$1.ZodURL>;
|
|
484
|
+
readmeUrls: z$1.ZodOptional<z$1.ZodRecord<z$1.ZodEnum<{
|
|
485
|
+
en: "en";
|
|
486
|
+
"zh-CN": "zh-CN";
|
|
487
|
+
"zh-Hant": "zh-Hant";
|
|
488
|
+
}> & z$1.core.$partial, z$1.ZodURL>>;
|
|
461
489
|
tags: z$1.ZodOptional<z$1.ZodArray<z$1.ZodString>>;
|
|
462
490
|
source: z$1.ZodString;
|
|
463
491
|
}, z$1.core.$strip>>;
|
|
@@ -518,32 +546,41 @@ type ToolRunInputDTOType = z.infer<typeof ToolRunInputDTOSchema>;
|
|
|
518
546
|
declare const ToolListItemDTOSchema: z.ZodObject<{
|
|
519
547
|
children: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
520
548
|
id: z.ZodString;
|
|
521
|
-
name: z.ZodObject<{
|
|
549
|
+
name: z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodObject<{
|
|
522
550
|
en: z.ZodString;
|
|
523
551
|
"zh-CN": z.ZodString;
|
|
524
552
|
"zh-Hant": z.ZodOptional<z.ZodString>;
|
|
525
|
-
}, z.core.$strip
|
|
526
|
-
description: z.ZodOptional<z.ZodObject<{
|
|
553
|
+
}, z.core.$strip>>;
|
|
554
|
+
description: z.ZodOptional<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodObject<{
|
|
527
555
|
en: z.ZodString;
|
|
528
556
|
"zh-CN": z.ZodString;
|
|
529
557
|
"zh-Hant": z.ZodOptional<z.ZodString>;
|
|
530
|
-
}, z.core.$strip
|
|
531
|
-
toolDescription: z.ZodString
|
|
558
|
+
}, z.core.$strip>>>;
|
|
559
|
+
toolDescription: z.ZodUnion<readonly [z.ZodString, z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodObject<{
|
|
560
|
+
en: z.ZodString;
|
|
561
|
+
"zh-CN": z.ZodString;
|
|
562
|
+
"zh-Hant": z.ZodOptional<z.ZodString>;
|
|
563
|
+
}, z.core.$strip>>]>;
|
|
532
564
|
}, z.core.$strip>>>;
|
|
533
565
|
source: z.ZodUnion<[z.ZodLiteral<"system">, z.ZodString]>;
|
|
534
566
|
isToolset: z.ZodBoolean;
|
|
535
567
|
hasSecret: z.ZodBoolean;
|
|
568
|
+
name: z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodObject<{
|
|
569
|
+
en: z.ZodString;
|
|
570
|
+
"zh-CN": z.ZodString;
|
|
571
|
+
"zh-Hant": z.ZodOptional<z.ZodString>;
|
|
572
|
+
}, z.core.$strip>>;
|
|
536
573
|
type: z.ZodLiteral<"tool">;
|
|
537
|
-
|
|
574
|
+
toolDescription: z.ZodUnion<readonly [z.ZodString, z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodObject<{
|
|
538
575
|
en: z.ZodString;
|
|
539
576
|
"zh-CN": z.ZodString;
|
|
540
577
|
"zh-Hant": z.ZodOptional<z.ZodString>;
|
|
541
|
-
}, z.core.$strip>;
|
|
542
|
-
description: z.ZodObject<{
|
|
578
|
+
}, z.core.$strip>>]>;
|
|
579
|
+
description: z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodObject<{
|
|
543
580
|
en: z.ZodString;
|
|
544
581
|
"zh-CN": z.ZodString;
|
|
545
582
|
"zh-Hant": z.ZodOptional<z.ZodString>;
|
|
546
|
-
}, z.core.$strip
|
|
583
|
+
}, z.core.$strip>>;
|
|
547
584
|
pluginId: z.ZodString;
|
|
548
585
|
version: z.ZodString;
|
|
549
586
|
etag: z.ZodString;
|
|
@@ -552,6 +589,11 @@ declare const ToolListItemDTOSchema: z.ZodObject<{
|
|
|
552
589
|
icon: z.ZodString;
|
|
553
590
|
tutorialUrl: z.ZodOptional<z.ZodURL>;
|
|
554
591
|
readmeUrl: z.ZodOptional<z.ZodURL>;
|
|
592
|
+
readmeUrls: z.ZodOptional<z.ZodRecord<z.ZodEnum<{
|
|
593
|
+
en: "en";
|
|
594
|
+
"zh-CN": "zh-CN";
|
|
595
|
+
"zh-Hant": "zh-Hant";
|
|
596
|
+
}> & z.core.$partial, z.ZodURL>>;
|
|
555
597
|
tags: z.ZodOptional<z.ZodArray<z.ZodEnum<{
|
|
556
598
|
search: "search";
|
|
557
599
|
tools: "tools";
|
|
@@ -566,38 +608,46 @@ declare const ToolListItemDTOSchema: z.ZodObject<{
|
|
|
566
608
|
scientific: "scientific";
|
|
567
609
|
other: "other";
|
|
568
610
|
}>>>;
|
|
569
|
-
toolDescription: z.ZodString;
|
|
570
611
|
}, z.core.$strip>;
|
|
571
612
|
type ToolListItemDTOType = z.infer<typeof ToolListItemDTOSchema>;
|
|
572
613
|
declare const ToolListDTOSchema: z.ZodArray<z.ZodObject<{
|
|
573
614
|
children: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
574
615
|
id: z.ZodString;
|
|
575
|
-
name: z.ZodObject<{
|
|
616
|
+
name: z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodObject<{
|
|
576
617
|
en: z.ZodString;
|
|
577
618
|
"zh-CN": z.ZodString;
|
|
578
619
|
"zh-Hant": z.ZodOptional<z.ZodString>;
|
|
579
|
-
}, z.core.$strip
|
|
580
|
-
description: z.ZodOptional<z.ZodObject<{
|
|
620
|
+
}, z.core.$strip>>;
|
|
621
|
+
description: z.ZodOptional<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodObject<{
|
|
581
622
|
en: z.ZodString;
|
|
582
623
|
"zh-CN": z.ZodString;
|
|
583
624
|
"zh-Hant": z.ZodOptional<z.ZodString>;
|
|
584
|
-
}, z.core.$strip
|
|
585
|
-
toolDescription: z.ZodString
|
|
625
|
+
}, z.core.$strip>>>;
|
|
626
|
+
toolDescription: z.ZodUnion<readonly [z.ZodString, z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodObject<{
|
|
627
|
+
en: z.ZodString;
|
|
628
|
+
"zh-CN": z.ZodString;
|
|
629
|
+
"zh-Hant": z.ZodOptional<z.ZodString>;
|
|
630
|
+
}, z.core.$strip>>]>;
|
|
586
631
|
}, z.core.$strip>>>;
|
|
587
632
|
source: z.ZodUnion<[z.ZodLiteral<"system">, z.ZodString]>;
|
|
588
633
|
isToolset: z.ZodBoolean;
|
|
589
634
|
hasSecret: z.ZodBoolean;
|
|
635
|
+
name: z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodObject<{
|
|
636
|
+
en: z.ZodString;
|
|
637
|
+
"zh-CN": z.ZodString;
|
|
638
|
+
"zh-Hant": z.ZodOptional<z.ZodString>;
|
|
639
|
+
}, z.core.$strip>>;
|
|
590
640
|
type: z.ZodLiteral<"tool">;
|
|
591
|
-
|
|
641
|
+
toolDescription: z.ZodUnion<readonly [z.ZodString, z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodObject<{
|
|
592
642
|
en: z.ZodString;
|
|
593
643
|
"zh-CN": z.ZodString;
|
|
594
644
|
"zh-Hant": z.ZodOptional<z.ZodString>;
|
|
595
|
-
}, z.core.$strip>;
|
|
596
|
-
description: z.ZodObject<{
|
|
645
|
+
}, z.core.$strip>>]>;
|
|
646
|
+
description: z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodObject<{
|
|
597
647
|
en: z.ZodString;
|
|
598
648
|
"zh-CN": z.ZodString;
|
|
599
649
|
"zh-Hant": z.ZodOptional<z.ZodString>;
|
|
600
|
-
}, z.core.$strip
|
|
650
|
+
}, z.core.$strip>>;
|
|
601
651
|
pluginId: z.ZodString;
|
|
602
652
|
version: z.ZodString;
|
|
603
653
|
etag: z.ZodString;
|
|
@@ -606,6 +656,11 @@ declare const ToolListDTOSchema: z.ZodArray<z.ZodObject<{
|
|
|
606
656
|
icon: z.ZodString;
|
|
607
657
|
tutorialUrl: z.ZodOptional<z.ZodURL>;
|
|
608
658
|
readmeUrl: z.ZodOptional<z.ZodURL>;
|
|
659
|
+
readmeUrls: z.ZodOptional<z.ZodRecord<z.ZodEnum<{
|
|
660
|
+
en: "en";
|
|
661
|
+
"zh-CN": "zh-CN";
|
|
662
|
+
"zh-Hant": "zh-Hant";
|
|
663
|
+
}> & z.core.$partial, z.ZodURL>>;
|
|
609
664
|
tags: z.ZodOptional<z.ZodArray<z.ZodEnum<{
|
|
610
665
|
search: "search";
|
|
611
666
|
tools: "tools";
|
|
@@ -620,7 +675,6 @@ declare const ToolListDTOSchema: z.ZodArray<z.ZodObject<{
|
|
|
620
675
|
scientific: "scientific";
|
|
621
676
|
other: "other";
|
|
622
677
|
}>>>;
|
|
623
|
-
toolDescription: z.ZodString;
|
|
624
678
|
}, z.core.$strip>>;
|
|
625
679
|
type ToolListDTOType = z.infer<typeof ToolListDTOSchema>;
|
|
626
680
|
declare const ToolDetailDTOSchema: z.ZodObject<{
|
|
@@ -628,24 +682,32 @@ declare const ToolDetailDTOSchema: z.ZodObject<{
|
|
|
628
682
|
isLatestVersion: z.ZodBoolean;
|
|
629
683
|
isToolset: z.ZodBoolean;
|
|
630
684
|
type: z.ZodLiteral<"tool">;
|
|
631
|
-
toolDescription: z.ZodString
|
|
685
|
+
toolDescription: z.ZodUnion<readonly [z.ZodString, z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodObject<{
|
|
686
|
+
en: z.ZodString;
|
|
687
|
+
"zh-CN": z.ZodString;
|
|
688
|
+
"zh-Hant": z.ZodOptional<z.ZodString>;
|
|
689
|
+
}, z.core.$strip>>]>;
|
|
632
690
|
inputSchema: z.ZodOptional<z.ZodAny>;
|
|
633
691
|
outputSchema: z.ZodOptional<z.ZodAny>;
|
|
634
692
|
secretSchema: z.ZodOptional<z.ZodAny>;
|
|
635
693
|
children: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
636
694
|
id: z.ZodString;
|
|
637
|
-
name: z.ZodObject<{
|
|
695
|
+
name: z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodObject<{
|
|
638
696
|
en: z.ZodString;
|
|
639
697
|
"zh-CN": z.ZodString;
|
|
640
698
|
"zh-Hant": z.ZodOptional<z.ZodString>;
|
|
641
|
-
}, z.core.$strip
|
|
642
|
-
description: z.ZodOptional<z.ZodObject<{
|
|
699
|
+
}, z.core.$strip>>;
|
|
700
|
+
description: z.ZodOptional<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodObject<{
|
|
643
701
|
en: z.ZodString;
|
|
644
702
|
"zh-CN": z.ZodString;
|
|
645
703
|
"zh-Hant": z.ZodOptional<z.ZodString>;
|
|
646
|
-
}, z.core.$strip
|
|
704
|
+
}, z.core.$strip>>>;
|
|
647
705
|
icon: z.ZodString;
|
|
648
|
-
toolDescription: z.ZodString
|
|
706
|
+
toolDescription: z.ZodUnion<readonly [z.ZodString, z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodObject<{
|
|
707
|
+
en: z.ZodString;
|
|
708
|
+
"zh-CN": z.ZodString;
|
|
709
|
+
"zh-Hant": z.ZodOptional<z.ZodString>;
|
|
710
|
+
}, z.core.$strip>>]>;
|
|
649
711
|
inputSchema: z.ZodAny;
|
|
650
712
|
outputSchema: z.ZodAny;
|
|
651
713
|
}, z.core.$strip>>>;
|
|
@@ -654,19 +716,24 @@ declare const ToolDetailDTOSchema: z.ZodObject<{
|
|
|
654
716
|
etag: z.ZodString;
|
|
655
717
|
author: z.ZodOptional<z.ZodString>;
|
|
656
718
|
repoUrl: z.ZodOptional<z.ZodString>;
|
|
657
|
-
name: z.ZodObject<{
|
|
719
|
+
name: z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodObject<{
|
|
658
720
|
en: z.ZodString;
|
|
659
721
|
"zh-CN": z.ZodString;
|
|
660
722
|
"zh-Hant": z.ZodOptional<z.ZodString>;
|
|
661
|
-
}, z.core.$strip
|
|
723
|
+
}, z.core.$strip>>;
|
|
662
724
|
icon: z.ZodString;
|
|
663
725
|
tutorialUrl: z.ZodOptional<z.ZodURL>;
|
|
664
726
|
readmeUrl: z.ZodOptional<z.ZodURL>;
|
|
665
|
-
|
|
727
|
+
readmeUrls: z.ZodOptional<z.ZodRecord<z.ZodEnum<{
|
|
728
|
+
en: "en";
|
|
729
|
+
"zh-CN": "zh-CN";
|
|
730
|
+
"zh-Hant": "zh-Hant";
|
|
731
|
+
}> & z.core.$partial, z.ZodURL>>;
|
|
732
|
+
description: z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodObject<{
|
|
666
733
|
en: z.ZodString;
|
|
667
734
|
"zh-CN": z.ZodString;
|
|
668
735
|
"zh-Hant": z.ZodOptional<z.ZodString>;
|
|
669
|
-
}, z.core.$strip
|
|
736
|
+
}, z.core.$strip>>;
|
|
670
737
|
tags: z.ZodOptional<z.ZodArray<z.ZodEnum<{
|
|
671
738
|
search: "search";
|
|
672
739
|
tools: "tools";
|
|
@@ -681,11 +748,11 @@ declare const ToolDetailDTOSchema: z.ZodObject<{
|
|
|
681
748
|
scientific: "scientific";
|
|
682
749
|
other: "other";
|
|
683
750
|
}>>>;
|
|
684
|
-
versionDescription: z.ZodOptional<z.ZodObject<{
|
|
751
|
+
versionDescription: z.ZodOptional<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodObject<{
|
|
685
752
|
en: z.ZodString;
|
|
686
753
|
"zh-CN": z.ZodString;
|
|
687
754
|
"zh-Hant": z.ZodOptional<z.ZodString>;
|
|
688
|
-
}, z.core.$strip
|
|
755
|
+
}, z.core.$strip>>>;
|
|
689
756
|
permission: z.ZodOptional<z.ZodArray<z.ZodEnum<{
|
|
690
757
|
"userInfo:read": "userInfo:read";
|
|
691
758
|
"teamInfo:read": "teamInfo:read";
|
|
@@ -812,6 +879,7 @@ declare const EmbeddingModelItemSchema: z$1.ZodObject<{
|
|
|
812
879
|
maxToken: z$1.ZodNumber;
|
|
813
880
|
weight: z$1.ZodOptional<z$1.ZodNumber>;
|
|
814
881
|
hidden: z$1.ZodOptional<z$1.ZodBoolean>;
|
|
882
|
+
vision: z$1.ZodOptional<z$1.ZodBoolean>;
|
|
815
883
|
normalization: z$1.ZodOptional<z$1.ZodBoolean>;
|
|
816
884
|
defaultConfig: z$1.ZodOptional<z$1.ZodRecord<z$1.ZodString, z$1.ZodAny>>;
|
|
817
885
|
dbConfig: z$1.ZodOptional<z$1.ZodRecord<z$1.ZodString, z$1.ZodAny>>;
|
|
@@ -895,6 +963,7 @@ declare const ModelItemSchema: z$1.ZodDiscriminatedUnion<[z$1.ZodObject<{
|
|
|
895
963
|
maxToken: z$1.ZodNumber;
|
|
896
964
|
weight: z$1.ZodOptional<z$1.ZodNumber>;
|
|
897
965
|
hidden: z$1.ZodOptional<z$1.ZodBoolean>;
|
|
966
|
+
vision: z$1.ZodOptional<z$1.ZodBoolean>;
|
|
898
967
|
normalization: z$1.ZodOptional<z$1.ZodBoolean>;
|
|
899
968
|
defaultConfig: z$1.ZodOptional<z$1.ZodRecord<z$1.ZodString, z$1.ZodAny>>;
|
|
900
969
|
dbConfig: z$1.ZodOptional<z$1.ZodRecord<z$1.ZodString, z$1.ZodAny>>;
|
|
@@ -940,24 +1009,32 @@ type ModelItemType = z$1.infer<typeof ModelItemSchema>;
|
|
|
940
1009
|
//#region ../../packages/domain/src/entities/tool.entity.d.ts
|
|
941
1010
|
declare const ToolSchema: z$1.ZodObject<{
|
|
942
1011
|
type: z$1.ZodLiteral<"tool">;
|
|
943
|
-
toolDescription: z$1.ZodString
|
|
1012
|
+
toolDescription: z$1.ZodUnion<readonly [z$1.ZodString, z$1.ZodPipe<z$1.ZodTransform<unknown, unknown>, z$1.ZodObject<{
|
|
1013
|
+
en: z$1.ZodString;
|
|
1014
|
+
"zh-CN": z$1.ZodString;
|
|
1015
|
+
"zh-Hant": z$1.ZodOptional<z$1.ZodString>;
|
|
1016
|
+
}, z$1.core.$strip>>]>;
|
|
944
1017
|
inputSchema: z$1.ZodOptional<z$1.ZodAny>;
|
|
945
1018
|
outputSchema: z$1.ZodOptional<z$1.ZodAny>;
|
|
946
1019
|
secretSchema: z$1.ZodOptional<z$1.ZodAny>;
|
|
947
1020
|
children: z$1.ZodOptional<z$1.ZodArray<z$1.ZodObject<{
|
|
948
1021
|
id: z$1.ZodString;
|
|
949
|
-
name: z$1.ZodObject<{
|
|
1022
|
+
name: z$1.ZodPipe<z$1.ZodTransform<unknown, unknown>, z$1.ZodObject<{
|
|
950
1023
|
en: z$1.ZodString;
|
|
951
1024
|
"zh-CN": z$1.ZodString;
|
|
952
1025
|
"zh-Hant": z$1.ZodOptional<z$1.ZodString>;
|
|
953
|
-
}, z$1.core.$strip
|
|
954
|
-
description: z$1.ZodOptional<z$1.ZodObject<{
|
|
1026
|
+
}, z$1.core.$strip>>;
|
|
1027
|
+
description: z$1.ZodOptional<z$1.ZodPipe<z$1.ZodTransform<unknown, unknown>, z$1.ZodObject<{
|
|
955
1028
|
en: z$1.ZodString;
|
|
956
1029
|
"zh-CN": z$1.ZodString;
|
|
957
1030
|
"zh-Hant": z$1.ZodOptional<z$1.ZodString>;
|
|
958
|
-
}, z$1.core.$strip
|
|
1031
|
+
}, z$1.core.$strip>>>;
|
|
959
1032
|
icon: z$1.ZodString;
|
|
960
|
-
toolDescription: z$1.ZodString
|
|
1033
|
+
toolDescription: z$1.ZodUnion<readonly [z$1.ZodString, z$1.ZodPipe<z$1.ZodTransform<unknown, unknown>, z$1.ZodObject<{
|
|
1034
|
+
en: z$1.ZodString;
|
|
1035
|
+
"zh-CN": z$1.ZodString;
|
|
1036
|
+
"zh-Hant": z$1.ZodOptional<z$1.ZodString>;
|
|
1037
|
+
}, z$1.core.$strip>>]>;
|
|
961
1038
|
inputSchema: z$1.ZodAny;
|
|
962
1039
|
outputSchema: z$1.ZodAny;
|
|
963
1040
|
}, z$1.core.$strip>>>;
|
|
@@ -966,19 +1043,24 @@ declare const ToolSchema: z$1.ZodObject<{
|
|
|
966
1043
|
etag: z$1.ZodString;
|
|
967
1044
|
author: z$1.ZodOptional<z$1.ZodString>;
|
|
968
1045
|
repoUrl: z$1.ZodOptional<z$1.ZodString>;
|
|
969
|
-
name: z$1.ZodObject<{
|
|
1046
|
+
name: z$1.ZodPipe<z$1.ZodTransform<unknown, unknown>, z$1.ZodObject<{
|
|
970
1047
|
en: z$1.ZodString;
|
|
971
1048
|
"zh-CN": z$1.ZodString;
|
|
972
1049
|
"zh-Hant": z$1.ZodOptional<z$1.ZodString>;
|
|
973
|
-
}, z$1.core.$strip
|
|
1050
|
+
}, z$1.core.$strip>>;
|
|
974
1051
|
icon: z$1.ZodString;
|
|
975
1052
|
tutorialUrl: z$1.ZodOptional<z$1.ZodURL>;
|
|
976
1053
|
readmeUrl: z$1.ZodOptional<z$1.ZodURL>;
|
|
977
|
-
|
|
1054
|
+
readmeUrls: z$1.ZodOptional<z$1.ZodRecord<z$1.ZodEnum<{
|
|
1055
|
+
en: "en";
|
|
1056
|
+
"zh-CN": "zh-CN";
|
|
1057
|
+
"zh-Hant": "zh-Hant";
|
|
1058
|
+
}> & z$1.core.$partial, z$1.ZodURL>>;
|
|
1059
|
+
description: z$1.ZodPipe<z$1.ZodTransform<unknown, unknown>, z$1.ZodObject<{
|
|
978
1060
|
en: z$1.ZodString;
|
|
979
1061
|
"zh-CN": z$1.ZodString;
|
|
980
1062
|
"zh-Hant": z$1.ZodOptional<z$1.ZodString>;
|
|
981
|
-
}, z$1.core.$strip
|
|
1063
|
+
}, z$1.core.$strip>>;
|
|
982
1064
|
tags: z$1.ZodOptional<z$1.ZodArray<z$1.ZodEnum<{
|
|
983
1065
|
search: "search";
|
|
984
1066
|
tools: "tools";
|
|
@@ -993,11 +1075,11 @@ declare const ToolSchema: z$1.ZodObject<{
|
|
|
993
1075
|
scientific: "scientific";
|
|
994
1076
|
other: "other";
|
|
995
1077
|
}>>>;
|
|
996
|
-
versionDescription: z$1.ZodOptional<z$1.ZodObject<{
|
|
1078
|
+
versionDescription: z$1.ZodOptional<z$1.ZodPipe<z$1.ZodTransform<unknown, unknown>, z$1.ZodObject<{
|
|
997
1079
|
en: z$1.ZodString;
|
|
998
1080
|
"zh-CN": z$1.ZodString;
|
|
999
1081
|
"zh-Hant": z$1.ZodOptional<z$1.ZodString>;
|
|
1000
|
-
}, z$1.core.$strip
|
|
1082
|
+
}, z$1.core.$strip>>>;
|
|
1001
1083
|
permission: z$1.ZodOptional<z$1.ZodArray<z$1.ZodEnum<{
|
|
1002
1084
|
"userInfo:read": "userInfo:read";
|
|
1003
1085
|
"teamInfo:read": "teamInfo:read";
|
|
@@ -1033,6 +1115,12 @@ type PluginTypeType = z$1.infer<typeof PluginTypeSchema>;
|
|
|
1033
1115
|
type PluginType = ToolType;
|
|
1034
1116
|
//#endregion
|
|
1035
1117
|
//#region ../../packages/domain/src/value-objects/i18n-string.vo.d.ts
|
|
1118
|
+
declare const I18nLangSchema: z$1.ZodEnum<{
|
|
1119
|
+
en: "en";
|
|
1120
|
+
"zh-CN": "zh-CN";
|
|
1121
|
+
"zh-Hant": "zh-Hant";
|
|
1122
|
+
}>;
|
|
1123
|
+
type I18nLangType = z$1.infer<typeof I18nLangSchema>;
|
|
1036
1124
|
declare const I18nStringSchema: z$1.ZodObject<{
|
|
1037
1125
|
en: z$1.ZodString;
|
|
1038
1126
|
"zh-CN": z$1.ZodString;
|
|
@@ -1266,6 +1354,7 @@ type ParsedPkgFiles = {
|
|
|
1266
1354
|
index: ParsedPkgFile;
|
|
1267
1355
|
manifest: ParsedPkgFile;
|
|
1268
1356
|
readme?: ParsedPkgFile;
|
|
1357
|
+
readmes?: Partial<Record<I18nLangType, ParsedPkgFile>>;
|
|
1269
1358
|
assets?: ParsedPkgFile[];
|
|
1270
1359
|
logos?: ParsedPkgFile[];
|
|
1271
1360
|
};
|
|
@@ -1291,6 +1380,7 @@ type AIProxyChannelsType = {
|
|
|
1291
1380
|
channelId: number;
|
|
1292
1381
|
name: I18nStringStrictType;
|
|
1293
1382
|
avatar: string;
|
|
1383
|
+
website: string;
|
|
1294
1384
|
}[];
|
|
1295
1385
|
//#endregion
|
|
1296
1386
|
export { type AIProxyChannelsType, type AIProxyChannelItemType as AiproxyMapProviderItemType, type ClientRequestOptions, type EmbeddingModelItemType, FastGPTPluginClient, type FastGPTPluginClientOptions, type I18nStringStrictType, type I18nStringType, type JsonObject, type LLMModelItemType, type ModelItemType, type ModelListType, type ModelProviderItemType, type ModelProviderListType, type ParsePkgParams, type ParsedPkgFile, type ParsedPkgFiles, type PluginConfirmResultType, type PluginDebugSessionConnectionKeyExchangeParamsType, type PluginDebugSessionConnectionKeyExchangeResultType, type PluginDebugSessionCreateParamsType, type PluginDebugSessionCreateResultType, type PluginDebugSessionRevokeParamsType, type PluginDebugSessionRevokeResultType, type PluginDebugSessionStatusParamsType, type PluginDebugSessionStatusResultType, type PluginDebugSessionStatusType, type PluginDeleteParamsType, type PluginInstallFailureType, type PluginInstallResultType, type PluginListItemType, type PluginListParamsType, type PluginListType, PluginPermissionEnum, PluginPermissionEnumSchema, type PluginPermissionEnumType, type PluginPruneDisabledResultType, type PluginRuntimeConfigType, type PluginServiceFeaturesType, type PluginSourceRequestOptions, type PluginSourceType, type PluginSummaryType, type PluginTagListItemType, type PluginTagListType, type PluginTagType, type PluginTypeType, type PluginUniqueIdType, type PluginUploadFailureType, type PluginUploadResultType, type PluginVersionItemType, type PluginVersionListParamsType, type PluginVersionListType, type RerankModelItemType, type RunToolStreamParams, RunToolWithStream, type STTModelItemType, type SystemVarType, type TTSModelItemType, type ToolAnswerType, type ToolDetailType, type ToolGetParamsType, type ToolHandlerReturnType, type ToolListItemType, type ToolListParamsType, type ToolListType, type ToolRunInputType, type ToolStreamMessageType, type WorkflowListType, type WorkflowTemplateType, parsePkg, pluginTagList };
|