@wecode-team/cms-supabase-api 0.1.35 → 0.1.37
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/README.md +17 -16
- package/dist/handlers/upload.d.ts +1 -1
- package/dist/index.esm.js +1307 -848
- package/dist/index.esm.js.map +1 -1
- package/dist/index.js +1307 -848
- package/dist/index.js.map +1 -1
- package/dist/services/oss-upload.service.d.ts +1 -0
- package/dist/types/index.d.ts +12 -0
- package/dist/types/upload.d.ts +24 -9
- package/dist/utils/admin-registry.d.ts +2 -0
- package/package.json +5 -4
package/README.md
CHANGED
|
@@ -115,13 +115,10 @@ await initializeCmsSystem()
|
|
|
115
115
|
|
|
116
116
|
// 初始化 OSS 上传
|
|
117
117
|
initializeOssUpload({
|
|
118
|
-
|
|
119
|
-
endpoint: process.env.OSS_ENDPOINT!,
|
|
120
|
-
accessKeyId: process.env.OSS_ACCESS_KEY_ID!,
|
|
121
|
-
accessKeySecret: process.env.OSS_ACCESS_KEY_SECRET!,
|
|
122
|
-
publicBaseUrl: process.env.OSS_PUBLIC_BASE_URL,
|
|
118
|
+
baseURL: process.env.OSS_BASE_URL || 'https://we0.ai',
|
|
123
119
|
prefix: 'cms-assets',
|
|
124
120
|
returnMode: 'both',
|
|
121
|
+
skipValidation: false,
|
|
125
122
|
})
|
|
126
123
|
|
|
127
124
|
// 一键创建所有 CMS 路由
|
|
@@ -211,7 +208,7 @@ export default app
|
|
|
211
208
|
|
|
212
209
|
| 方法 | 路径 | 描述 |
|
|
213
210
|
|------|------|------|
|
|
214
|
-
| POST | `/upload` |
|
|
211
|
+
| POST | `/upload` | 上传单个文件到 OSS 服务，默认需要管理员登录 |
|
|
215
212
|
|
|
216
213
|
### 认证
|
|
217
214
|
|
|
@@ -238,20 +235,23 @@ export default app
|
|
|
238
235
|
|
|
239
236
|
```typescript
|
|
240
237
|
initializeOssUpload({
|
|
241
|
-
|
|
242
|
-
endpoint: process.env.OSS_ENDPOINT!,
|
|
243
|
-
accessKeyId: process.env.OSS_ACCESS_KEY_ID!,
|
|
244
|
-
accessKeySecret: process.env.OSS_ACCESS_KEY_SECRET!,
|
|
245
|
-
publicBaseUrl: process.env.OSS_PUBLIC_BASE_URL,
|
|
238
|
+
baseURL: process.env.OSS_BASE_URL || "https://we0.ai",
|
|
246
239
|
prefix: "cms-assets",
|
|
247
240
|
maxSize: 2 * 1024 * 1024,
|
|
248
241
|
returnMode: "both",
|
|
249
|
-
|
|
242
|
+
timeout: 30_000,
|
|
243
|
+
retry: { retries: 2, delay: 1000 },
|
|
244
|
+
skipValidation: false,
|
|
250
245
|
})
|
|
251
246
|
|
|
252
247
|
createOssUploadRoute(app)
|
|
253
248
|
```
|
|
254
249
|
|
|
250
|
+
兼容说明：
|
|
251
|
+
|
|
252
|
+
- 推荐使用 `baseURL` 对接 `@wecode-team/oss` 服务
|
|
253
|
+
- `bucket`、`endpoint`、`accessKeyId`、`accessKeySecret`、`publicBaseUrl` 仍可保留在配置类型中，但在 SDK 模式下不再必填
|
|
254
|
+
|
|
255
255
|
上传请求要求：
|
|
256
256
|
|
|
257
257
|
- `POST /upload`
|
|
@@ -259,14 +259,15 @@ createOssUploadRoute(app)
|
|
|
259
259
|
- 文件字段名固定为 `file`
|
|
260
260
|
- 可选文本字段：`directory`、`fieldName`、`tableName`
|
|
261
261
|
- 默认要求 `Authorization` 和 `X-Session-Id`，并通过现有 admin 鉴权
|
|
262
|
+
- `X-Session-Id` 为必填，因为 `@wecode-team/oss` 以 `sessionId` 作为文件隔离维度
|
|
262
263
|
|
|
263
264
|
上传成功返回：
|
|
264
265
|
|
|
265
266
|
```json
|
|
266
267
|
{
|
|
267
268
|
"success": true,
|
|
268
|
-
"url": "https://
|
|
269
|
-
"signedUrl": "https://
|
|
269
|
+
"url": "https://we0.ai/api/oss/files/site_config/logo.png",
|
|
270
|
+
"signedUrl": "https://we0.ai/api/oss/files/site_config/logo.png",
|
|
270
271
|
"objectKey": "cms-assets/logos/20260316120000-abcdef.png",
|
|
271
272
|
"fieldName": "logo",
|
|
272
273
|
"tableName": "site_config"
|
|
@@ -275,8 +276,8 @@ createOssUploadRoute(app)
|
|
|
275
276
|
|
|
276
277
|
`returnMode` 说明：
|
|
277
278
|
|
|
278
|
-
- `public-url`:
|
|
279
|
-
- `signed-url`:
|
|
279
|
+
- `public-url`: 只返回 `url`
|
|
280
|
+
- `signed-url`: 当前 SDK 适配层会把 `url` 和 `signedUrl` 都映射为 SDK 返回地址
|
|
280
281
|
- `both`: 同时返回 `url` 和 `signedUrl`
|
|
281
282
|
|
|
282
283
|
如果 bucket 是私有读，推荐使用 `signed-url` 或 `both`。
|