@wecode-team/cms-supabase-api 0.1.34 → 0.1.35

package/README.md

@@ -94,7 +94,9 @@ import { cors } from 'hono/cors'
 import { 
   initializeSupabase, 
   initializeCmsSystem,
-  createCmsRoutes 
+  initializeOssUpload,
+  createCmsRoutes,
+  createOssUploadRoute,
 } from '@wecode-team/cms-supabase-api'
 
 const app = new Hono()
@@ -111,9 +113,23 @@ initializeSupabase({
 // 初始化 CMS 系统表
 await initializeCmsSystem()
 
+// 初始化 OSS 上传
+initializeOssUpload({
+  bucket: process.env.OSS_BUCKET!,
+  endpoint: process.env.OSS_ENDPOINT!,
+  accessKeyId: process.env.OSS_ACCESS_KEY_ID!,
+  accessKeySecret: process.env.OSS_ACCESS_KEY_SECRET!,
+  publicBaseUrl: process.env.OSS_PUBLIC_BASE_URL,
+  prefix: 'cms-assets',
+  returnMode: 'both',
+})
+
 // 一键创建所有 CMS 路由
 createCmsRoutes(app)
 
+// 创建上传路由
+createOssUploadRoute(app)
+
 export default app
 ```
 
@@ -191,6 +207,12 @@ export default app
 |------|------|------|
 | GET | `/relation/:tableName/options` | 获取关联表选项（用于下拉选择） |
 
+### 资源上传
+
+| 方法 | 路径 | 描述 |
+|------|------|------|
+| POST | `/upload` | 上传单个文件到阿里云 OSS，默认需要管理员登录 |
+
 ### 认证
 
 | 方法 | 路径 | 描述 |
@@ -205,6 +227,60 @@ export default app
 
 > 提示：后台管理接口（`/models`、`/data/*` 等）建议携带请求头 `X-Session-Id`，用于按 `session_id` 维度校验管理员权限。
 
+## ☁️ OSS 上传
+
+宿主项目只需要两步：
+
+1. 调用 `initializeOssUpload(config)`
+2. 调用 `createOssUploadRoute(app)`
+
+最小示例：
+
+```typescript
+initializeOssUpload({
+  bucket: process.env.OSS_BUCKET!,
+  endpoint: process.env.OSS_ENDPOINT!,
+  accessKeyId: process.env.OSS_ACCESS_KEY_ID!,
+  accessKeySecret: process.env.OSS_ACCESS_KEY_SECRET!,
+  publicBaseUrl: process.env.OSS_PUBLIC_BASE_URL,
+  prefix: "cms-assets",
+  maxSize: 2 * 1024 * 1024,
+  returnMode: "both",
+  signedUrlExpiresIn: 60 * 60,
+})
+
+createOssUploadRoute(app)
+```
+
+上传请求要求：
+
+- `POST /upload`
+- `multipart/form-data`
+- 文件字段名固定为 `file`
+- 可选文本字段：`directory`、`fieldName`、`tableName`
+- 默认要求 `Authorization` 和 `X-Session-Id`，并通过现有 admin 鉴权
+
+上传成功返回：
+
+```json
+{
+  "success": true,
+  "url": "https://bucket.endpoint/path/to/object.png",
+  "signedUrl": "https://bucket.endpoint/path/to/object.png?...",
+  "objectKey": "cms-assets/logos/20260316120000-abcdef.png",
+  "fieldName": "logo",
+  "tableName": "site_config"
+}
+```
+
+`returnMode` 说明：
+
+- `public-url`: 返回公开 URL
+- `signed-url`: 返回签名 URL，并将 `url` 也设置为该签名地址
+- `both`: 同时返回 `url` 和 `signedUrl`
+
+如果 bucket 是私有读，推荐使用 `signed-url` 或 `both`。
+
 ## 🏗️ 字段类型
 
 | 类型 | PostgreSQL 类型 | 说明 |

package/USAGE_EXAMPLE.md

@@ -9,7 +9,9 @@
 import { Hono } from 'hono'
 import { 
   initializeSupabase, 
+  initializeOssUpload,
   createCmsRoutes,
+  createOssUploadRoute,
   testConnection 
 } from '@wecode-team/cms-supabase-api'
 
@@ -24,8 +26,18 @@ initializeSupabase({
 // 测试连接
 await testConnection()
 
+initializeOssUpload({
+  bucket: 'your-bucket',
+  endpoint: 'oss-cn-beijing.aliyuncs.com',
+  accessKeyId: 'your-access-key-id',
+  accessKeySecret: 'your-access-key-secret',
+  publicBaseUrl: 'https://your-bucket.oss-cn-beijing.aliyuncs.com',
+  returnMode: 'both',
+})
+
 // 创建所有 CMS 路由
 createCmsRoutes(app)
+createOssUploadRoute(app)
 
 // 添加自定义路由
 app.get('/', (c) => {
@@ -45,7 +57,9 @@ import { serve } from '@hono/node-server'
 import { Hono } from 'hono'
 import { 
   initializeSupabase, 
-  createCmsRoutes 
+  initializeOssUpload,
+  createCmsRoutes,
+  createOssUploadRoute,
 } from '@wecode-team/cms-supabase-api'
 
 const app = new Hono()
@@ -56,8 +70,18 @@ initializeSupabase({
   key: process.env.SUPABASE_ANON_KEY!
 })
 
+initializeOssUpload({
+  bucket: process.env.OSS_BUCKET!,
+  endpoint: process.env.OSS_ENDPOINT!,
+  accessKeyId: process.env.OSS_ACCESS_KEY_ID!,
+  accessKeySecret: process.env.OSS_ACCESS_KEY_SECRET!,
+  publicBaseUrl: process.env.OSS_PUBLIC_BASE_URL,
+  returnMode: 'both',
+})
+
 // 添加路由
 createCmsRoutes(app)
+createOssUploadRoute(app)
 
 // 启动服务器
 const port = 3000
@@ -76,7 +100,9 @@ serve({
 import { Hono } from 'hono'
 import { 
   initializeSupabase, 
-  createCmsRoutes 
+  initializeOssUpload,
+  createCmsRoutes,
+  createOssUploadRoute,
 } from '@wecode-team/cms-supabase-api'
 
 const app = new Hono()
@@ -86,7 +112,17 @@ initializeSupabase({
   key: Bun.env.SUPABASE_ANON_KEY!
 })
 
+initializeOssUpload({
+  bucket: Bun.env.OSS_BUCKET!,
+  endpoint: Bun.env.OSS_ENDPOINT!,
+  accessKeyId: Bun.env.OSS_ACCESS_KEY_ID!,
+  accessKeySecret: Bun.env.OSS_ACCESS_KEY_SECRET!,
+  publicBaseUrl: Bun.env.OSS_PUBLIC_BASE_URL,
+  returnMode: 'both',
+})
+
 createCmsRoutes(app)
+createOssUploadRoute(app)
 
 export default {
   port: 3000,
@@ -139,6 +175,38 @@ app.get('/health', (c) => {
 export default app
 ```
 
+### 资源上传路由
+
+```typescript
+import { Hono } from 'hono'
+import {
+  initializeSupabase,
+  initializeOssUpload,
+  createOssUploadRoute,
+} from '@wecode-team/cms-supabase-api'
+
+const app = new Hono()
+
+initializeSupabase({
+  url: process.env.SUPABASE_URL!,
+  key: process.env.SUPABASE_ANON_KEY!,
+})
+
+initializeOssUpload({
+  bucket: process.env.OSS_BUCKET!,
+  endpoint: process.env.OSS_ENDPOINT!,
+  accessKeyId: process.env.OSS_ACCESS_KEY_ID!,
+  accessKeySecret: process.env.OSS_ACCESS_KEY_SECRET!,
+  publicBaseUrl: process.env.OSS_PUBLIC_BASE_URL,
+  prefix: 'cms-assets',
+  returnMode: 'both',
+})
+
+createOssUploadRoute(app)
+
+export default app
+```
+
 ### 使用固定表名的认证
 
 ```typescript
@@ -264,4 +332,3 @@ curl http://localhost:3000/auth/cms_users/current \
   -H "Authorization: Bearer YOUR_JWT_TOKEN"
 ```
 
-

package/dist/handlers/upload.d.ts

@@ -0,0 +1,25 @@
+import type { Context } from "hono";
+export declare function uploadToOss(c: Context): Promise<(Response & import("hono").TypedResponse<{
+    success: boolean;
+    url?: string | undefined;
+    signedUrl?: string | undefined;
+    objectKey?: string | undefined;
+    fieldName?: string | undefined;
+    tableName?: string | undefined;
+    message?: string | undefined;
+    error?: string | undefined;
+}, 200, "json">) | (Response & import("hono").TypedResponse<{
+    success: boolean;
+    message?: string | undefined;
+    data?: {
+        success: boolean;
+        url?: string | undefined;
+        signedUrl?: string | undefined;
+        objectKey?: string | undefined;
+        fieldName?: string | undefined;
+        tableName?: string | undefined;
+        message?: string | undefined;
+        error?: string | undefined;
+    } | undefined;
+    error?: string | undefined;
+}, 400 | 500 | 403 | 502, "json">)>;

package/dist/index.d.ts

@@ -3,9 +3,12 @@ export { default as CmsModelService, getCmsModelService, initializeCmsModel, } f
 export { getCmsModelService as CmsModel } from "./models/cms-model";
 export { DynamicTableService, getDynamicTableService, } from "./services/dynamic-table.service";
 export { AuthService, getAuthService, } from "./services/auth.service";
+export { OssUploadService, OssUploadError, initializeOssUpload, getOssUploadService, } from "./services/oss-upload.service";
 export { getModels, createModel, updateModel, deleteModel, } from "./handlers/models";
 export { getTableData, createTableData, updateTableData, deleteTableData, getRelationOptions, getTableDataWithRelations, dropForeignKeys, } from "./handlers/data";
 export { login, signup, signupStatus, verifyAuth, getCurrentUser, requireAuth, } from "./handlers/auth";
+export { uploadToOss, } from "./handlers/upload";
 export type { SchemaField, JsonSchema, CmsModelAttributes, CmsModelCreationAttributes, ApiResponse, PaginatedResponse, SupabaseConfig, DatabaseConfig, TableDataOptions, SupabaseFilter, FieldTypeMapping, RelationType, RelationConfig, RelationOption, GetRelationOptionsParams, } from "./types";
 export type { User, UserInfo, LoginRequest, LoginResponse, } from "./handlers/auth";
-export { createCmsRoutes, createModelRoute, createDynamicDataRoute, createDynamicAuthRoute, createDataRoute, createAuthRoute, } from "./utils/route-helpers";
+export { createCmsRoutes, createModelRoute, createDynamicDataRoute, createDynamicAuthRoute, createDataRoute, createAuthRoute, createOssUploadRoute, } from "./utils/route-helpers";
+export type { OssUploadProvider, OssUploadReturnMode, OssUploadConfig, NormalizedOssUploadConfig, OssUploadInput, OssUploadResult, UploadRouteResponse, } from "./types/upload";