ai-world-sdk 1.5.15 → 1.5.16
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/dist/config.d.ts +3 -3
- package/dist/config.js +3 -2
- package/package.json +1 -1
- package/skills/ai-world-sdk/SKILL.md +60 -1
package/dist/config.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
*
|
|
10
10
|
* 注意: {VERSION} 占位符会在构建时被替换为实际版本号
|
|
11
11
|
*/
|
|
12
|
-
export declare const SDK_SIGNATURE = "AI_WORLD_SDK_V:1.5.
|
|
12
|
+
export declare const SDK_SIGNATURE = "AI_WORLD_SDK_V:1.5.16";
|
|
13
13
|
/**
|
|
14
14
|
* 版本兼容性错误
|
|
15
15
|
*/
|
|
@@ -35,8 +35,8 @@ declare class SDKConfig {
|
|
|
35
35
|
private _authCheckPromise;
|
|
36
36
|
private _currentUser;
|
|
37
37
|
private _cliMode;
|
|
38
|
-
readonly sdkSignature = "AI_WORLD_SDK_V:1.5.
|
|
39
|
-
readonly sdkVersion = "1.5.
|
|
38
|
+
readonly sdkSignature = "AI_WORLD_SDK_V:1.5.16";
|
|
39
|
+
readonly sdkVersion = "1.5.16";
|
|
40
40
|
constructor();
|
|
41
41
|
/**
|
|
42
42
|
* Set global base URL
|
package/dist/config.js
CHANGED
|
@@ -7,7 +7,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
7
7
|
exports.sdkConfig = exports.VersionCompatibilityError = exports.SDK_SIGNATURE = void 0;
|
|
8
8
|
// SDK 版本号(构建时自动从 package.json 更新)
|
|
9
9
|
// 此版本号会在运行 npm run build 时自动从 package.json 读取并更新
|
|
10
|
-
const SDK_VERSION = "1.5.
|
|
10
|
+
const SDK_VERSION = "1.5.16";
|
|
11
11
|
/**
|
|
12
12
|
* SDK 特征码 - 用于在构建后的 JS 文件中识别 SDK 版本
|
|
13
13
|
* 格式: AI_WORLD_SDK_V:版本号
|
|
@@ -15,7 +15,7 @@ const SDK_VERSION = "1.5.15";
|
|
|
15
15
|
*
|
|
16
16
|
* 注意: {VERSION} 占位符会在构建时被替换为实际版本号
|
|
17
17
|
*/
|
|
18
|
-
exports.SDK_SIGNATURE = "AI_WORLD_SDK_V:1.5.
|
|
18
|
+
exports.SDK_SIGNATURE = "AI_WORLD_SDK_V:1.5.16";
|
|
19
19
|
/**
|
|
20
20
|
* 版本兼容性错误
|
|
21
21
|
*/
|
|
@@ -291,6 +291,7 @@ class SDKConfig {
|
|
|
291
291
|
const path = require('path');
|
|
292
292
|
const fs = require('fs');
|
|
293
293
|
const cwd = process.cwd();
|
|
294
|
+
console.log('server cwd:', cwd);
|
|
294
295
|
// .env.local 优先级最高(仅次于已有 process.env)
|
|
295
296
|
const envLocalPath = path.resolve(cwd, '.env.local');
|
|
296
297
|
if (fs.existsSync(envLocalPath)) {
|
package/package.json
CHANGED
|
@@ -119,11 +119,70 @@ sdkConfig.setToken('your-jwt-token');
|
|
|
119
119
|
sdkConfig.setPluginId('my-plugin');
|
|
120
120
|
```
|
|
121
121
|
|
|
122
|
-
|
|
122
|
+
也可通过环境变量自动初始化(SDK 自动读取 `.env.local` > `.env` > `AI_WORLD_ENV_FILE` 指定文件):
|
|
123
123
|
- `AI_WORLD_BASE_URL` — 服务端地址,插件 JS 后端启动时由平台自动注入
|
|
124
124
|
- `PLUGIN_ID` — 插件 ID
|
|
125
125
|
- `DEBUG_TOKEN` — 调试用 JWT Token
|
|
126
126
|
- `AI_WORLD_TOKEN` — 用户登录后获取的 JWT Token
|
|
127
|
+
- `AI_WORLD_ENV_FILE` — 指定自定义 `.env` 文件路径(绝对或相对路径均可)
|
|
128
|
+
|
|
129
|
+
### 插件 JS 后端环境(平台自动注入)
|
|
130
|
+
|
|
131
|
+
当插件配置了 Node.js 后端(`plugin.json` 的 `backend` 字段),平台启动子进程时会自动注入以下环境变量:
|
|
132
|
+
|
|
133
|
+
| 环境变量 | 说明 |
|
|
134
|
+
|----------|------|
|
|
135
|
+
| `PORT` | **插件后端必须监听的端口**(平台自动分配,范围 19000~19999) |
|
|
136
|
+
| `SERVER_PORT` | 同 `PORT`,兼容别名 |
|
|
137
|
+
| `PLUGIN_ID` | 当前插件 ID |
|
|
138
|
+
| `AI_WORLD_BASE_URL` | 平台后端地址(默认 `http://127.0.0.1:8000`) |
|
|
139
|
+
| `AI_WORLD_ENV_FILE` | 平台写入的 `.env` 文件路径(`server/.env`),SDK 自动加载 |
|
|
140
|
+
| `NODE_ENV` | 固定为 `production` |
|
|
141
|
+
|
|
142
|
+
**重要**:插件后端 **必须** 监听 `PORT` 环境变量指定的端口,否则平台无法正确代理请求。
|
|
143
|
+
|
|
144
|
+
```javascript
|
|
145
|
+
// server/index.js 示例
|
|
146
|
+
const express = require('express');
|
|
147
|
+
const app = express();
|
|
148
|
+
const port = process.env.PORT || 3000;
|
|
149
|
+
|
|
150
|
+
app.get('/health', (req, res) => res.json({ status: 'ok' }));
|
|
151
|
+
app.get('/api/hello', (req, res) => res.json({ message: 'Hello from plugin backend!' }));
|
|
152
|
+
|
|
153
|
+
app.listen(port, () => {
|
|
154
|
+
console.log(`Plugin backend listening on port ${port}`);
|
|
155
|
+
});
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
### 插件前端请求插件后端(HTTP 代理)
|
|
159
|
+
|
|
160
|
+
平台为每个 JS 后端插件注册了 HTTP 反向代理路由,**插件前端不需要知道后端实际端口**,统一通过以下地址访问:
|
|
161
|
+
|
|
162
|
+
```
|
|
163
|
+
{AI_WORLD_BASE_URL}/api/{plugin-id}/server/{path}
|
|
164
|
+
```
|
|
165
|
+
|
|
166
|
+
例如插件 ID 为 `my-plugin`,后端有 `/api/hello` 接口,前端请求地址为:
|
|
167
|
+
|
|
168
|
+
```
|
|
169
|
+
https://aiworld.local:8000/api/my-plugin/server/api/hello
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
在插件前端代码中使用 `sdkConfig` 获取 baseUrl:
|
|
173
|
+
|
|
174
|
+
```typescript
|
|
175
|
+
import { sdkConfig } from 'ai-world-sdk';
|
|
176
|
+
|
|
177
|
+
// 插件前端请求插件后端
|
|
178
|
+
const baseUrl = sdkConfig.getServerUrl();
|
|
179
|
+
const pluginId = sdkConfig.getPluginId();
|
|
180
|
+
const response = await fetch(`${baseUrl}/api/${pluginId}/server/api/hello`, {
|
|
181
|
+
headers: { 'Authorization': `Bearer ${sdkConfig.getToken()}` }
|
|
182
|
+
});
|
|
183
|
+
```
|
|
184
|
+
|
|
185
|
+
WebSocket 同理:`ws(s)://{host}/api/{plugin-id}/server/ws`
|
|
127
186
|
|
|
128
187
|
## 功能模块
|
|
129
188
|
|