@fastgpt-plugin/sdk-client 0.1.0-alpha.5 → 1.2.0-alpha.1

package/LICENSE

@@ -0,0 +1,35 @@
+# FastGPT Open Source License
+
+The FastGPT is licensed under the Apache License 2.0, with the following additional conditions:
+
+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:
+
+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.
+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.
+
+Please contact dennis@sealos.io by email to inquire about licensing matters.
+
+2. As a contributor, you should agree that your contributed code:
+
+a. The producer can adjust the open-source agreement to be more strict or relaxed.
+b. Can be used for commercial purposes, such as FastGPT's cloud business.
+
+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.
+
+The interactive design of this product is protected by appearance patent.
+
+© 2023 Sealos.
+
+---
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.en.md

@@ -2,22 +2,52 @@
 
 Language: [简体中文](./README.md) | [English](./README.en.md)
 
-Provides APIs for FastGPT to call FastGPT Plugin.
+The TypeScript client wraps the FastGPT Plugin service API. `FastGPTPluginClient` passes through service responses; it does not select display languages for callers.
 
-`listPlugins()` now returns a paginated structure:
+```ts
+import { FastGPTPluginClient } from '@fastgpt-plugin/sdk-client';
+
+const client = new FastGPTPluginClient({
+  baseUrl: 'https://plugin.example.com',
+  token: process.env.FASTGPT_PLUGIN_TOKEN
+});
+```
+
+## Workflow Templates
+
+`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.
 
 ```ts
-type PluginListType = {
-  data: PluginListItemType[];
-  offset: number;
-  limit: number;
-  total: number;
-};
+const templates = await client.listWorkflows();
+const templateName = templates[0]?.name;
+const firstInputLabel = templates[0]?.workflow.nodes[0]?.inputs?.[0]?.label;
 ```
 
-`PluginListItemType` and `PluginSourceType` are also exported so callers can handle the new `source` field and paginated responses.
+## Localized Plugin README URLs
+
+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.
+
+```ts
+type Locale = 'en' | 'zh-CN' | 'zh-Hant';
+
+const plugins = await client.listPlugins();
+const plugin = plugins[0];
+const locale: Locale = 'zh-Hant';
+const readmeUrl = plugin
+  ? plugin.readmeUrls?.[locale] ??
+    plugin.readmeUrls?.['zh-CN'] ??
+    plugin.readmeUrls?.en ??
+    plugin.readmeUrl
+  : undefined;
+```
+
+`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`.
+
+`PluginListType` is an array of plugin list items. `PluginListItemType` and `PluginSourceType` are also exported for handling the plugin `source` field.
+
+## Plugin Service Features
 
-`getPluginServiceFeatures()` returns the enabled Plugin service capabilities:
+`getPluginServiceFeatures()` returns the capabilities enabled on the current Plugin service:
 
 ```ts
 const features = await client.getPluginServiceFeatures();

package/README.md

@@ -1,23 +1,53 @@
-# FastGPT-plugin SDK client
+# FastGPT-plugin SDK Client
 
 语言：[简体中文](./README.md) | [English](./README.en.md)
 
-提供接口供 FastGPT 调用。
+TypeScript 客户端封装 FastGPT Plugin 服务 API。`FastGPTPluginClient` 的方法会透传服务端响应；SDK 不替调用方选择展示语言。
 
-`listPlugins()` 现在返回分页结构：
+```ts
+import { FastGPTPluginClient } from '@fastgpt-plugin/sdk-client';
+
+const client = new FastGPTPluginClient({
+  baseUrl: 'https://plugin.example.com',
+  token: process.env.FASTGPT_PLUGIN_TOKEN
+});
+```
+
+## 工作流模板
+
+`listWorkflows()` 不接收 locale 参数，也不会对工作流模板进行翻译；模板 `name`、`intro` 等字段按原字符串透传。工作流节点配置保持开放结构。
 
 ```ts
-type PluginListType = {
-  data: PluginListItemType[];
-  offset: number;
-  limit: number;
-  total: number;
-};
+const templates = await client.listWorkflows();
+const templateName = templates[0]?.name;
+const firstInputLabel = templates[0]?.workflow.nodes[0]?.inputs?.[0]?.label;
 ```
 
-同时导出了 `PluginListItemType` 和 `PluginSourceType`，方便调用方处理新的 `source` / 分页返回。
+## 多语言插件 README URL
+
+插件信息会同时保留兼容字段 `readmeUrl` 和实际存在的 README 语言映射 `readmeUrls`。UI 应先按当前语言查映射，然后回退到简体中文、英文；若新映射没有可用地址，最后可使用旧 `readmeUrl`。SDK 不解析 README 内容或做语言选择。
+
+```ts
+type Locale = 'en' | 'zh-CN' | 'zh-Hant';
+
+const plugins = await client.listPlugins();
+const plugin = plugins[0];
+const locale: Locale = 'zh-Hant';
+const readmeUrl = plugin
+  ? plugin.readmeUrls?.[locale] ??
+    plugin.readmeUrls?.['zh-CN'] ??
+    plugin.readmeUrls?.en ??
+    plugin.readmeUrl
+  : undefined;
+```
+
+`readmeUrls` 只包含包内实际提供的语言版本。服务端在根目录存在 `README.md` 时让 `readmeUrl` 指向它；否则按 `zh-CN`、`en`、`zh-Hant` 顺序选择可用变体。上述 UI 回退逻辑适用于展示端的语言选择；旧客户端仍可只读取 `readmeUrl`。
+
+`PluginListType` 是插件列表项数组；`PluginListItemType` 和 `PluginSourceType` 也从客户端 SDK 导出，供调用方处理插件来源字段。
+
+## Plugin 服务能力
 
-`getPluginServiceFeatures()` 可查询当前 Plugin 服务已启用的能力：
+`getPluginServiceFeatures()` 返回当前 Plugin 服务已启用的能力：
 
 ```ts
 const features = await client.getPluginServiceFeatures();