qing-client 0.0.25 → 0.0.27

package/lib/service/FileService.d.ts

@@ -1,6 +1,6 @@
 import { BaseClient } from "../client/BaseClient";
 import { ClientConfig, RequestOptions, PaginatedResponse } from "../types";
-import { File, CreateFileRequest, UpdateFileRequest, FileListQuery, Folder, FolderItemsResponse, FolderTreeNode, CreateFolderRequest, UpdateFolderRequest, OSSConfig, GenerateOSSUploadSignRequest, GenerateOSSUploadSignResponse, OSSCallbackQuery, OSSCallbackBody, OSSCallbackResponse } from "../types/file";
+import { File, CreateFileRequest, UpdateFileRequest, FileListQuery, Folder, FolderItemsResponse, FolderTreeNode, CreateFolderRequest, UpdateFolderRequest, OSSConfig, GenerateOSSUploadSignRequest, GenerateOSSUploadSignResponse, OSSCallbackQuery, OSSCallbackBody, OSSCallbackResponse, TaskOptionsResponse } from "../types/file";
 export declare class FileService extends BaseClient {
     constructor(config: ClientConfig);
     /**
@@ -26,6 +26,10 @@ export declare class FileService extends BaseClient {
     /**
      * 获取文件列表
      * GET /api/files (网关转发到 /api/v1/files)
+     *
+     * 权限说明：
+     * - 普通用户：只能查自己的文件，uid 参数会被忽略
+     * - 管理员/超管：可以查任意用户的文件，传 uid 查指定用户，不传则查所有
      */
     listFiles(query?: FileListQuery, options?: RequestOptions): Promise<PaginatedResponse<File>>;
     /**
@@ -38,6 +42,13 @@ export declare class FileService extends BaseClient {
      * GET /api/files/oss/config/:projectId (网关转发到 /api/v1/files/oss/config/:projectId)
      */
     getOSSConfig(projectId: string, options?: RequestOptions): Promise<OSSConfig>;
+    /**
+     * 获取当前项目可用的任务选项（用于前端 select 下拉框）
+     * GET /api/files/oss/task-options (网关转发到 /api/v1/files/oss/task-options)
+     *
+     * 根据请求头中的 x-project-id 自动获取当前项目可用的任务列表
+     */
+    getTaskOptions(options?: RequestOptions): Promise<TaskOptionsResponse>;
     /**
      * 创建文件夹
      * POST /api/files/folders (网关转发到 /api/v1/files/folders)

package/lib/service/FileService.js

@@ -69,6 +69,10 @@ class FileService extends BaseClient_1.BaseClient {
     /**
      * 获取文件列表
      * GET /api/files (网关转发到 /api/v1/files)
+     *
+     * 权限说明：
+     * - 普通用户：只能查自己的文件，uid 参数会被忽略
+     * - 管理员/超管：可以查任意用户的文件，传 uid 查指定用户，不传则查所有
      */
     async listFiles(query, options) {
         const params = {};
@@ -87,6 +91,9 @@ class FileService extends BaseClient_1.BaseClient {
         if (query?.acl !== undefined) {
             params.acl = query.acl;
         }
+        if (query?.uid !== undefined) {
+            params.uid = query.uid;
+        }
         const response = await this.paginatedRequest('', {
             ...options,
             method: 'GET',
@@ -116,6 +123,18 @@ class FileService extends BaseClient_1.BaseClient {
             method: 'GET'
         });
     }
+    /**
+     * 获取当前项目可用的任务选项（用于前端 select 下拉框）
+     * GET /api/files/oss/task-options (网关转发到 /api/v1/files/oss/task-options)
+     *
+     * 根据请求头中的 x-project-id 自动获取当前项目可用的任务列表
+     */
+    async getTaskOptions(options) {
+        return this.request('/oss/task-options', {
+            ...options,
+            method: 'GET'
+        });
+    }
     // ==================== 文件夹相关接口 ====================
     /**
      * 创建文件夹

package/lib/service/FrontHostService.d.ts

@@ -1,11 +1,13 @@
 import { BaseClient } from "../client/BaseClient";
-import { ClientConfig, RequestOptions } from "../types";
-import { FrontHostCreateProjectInput, FrontHostDomainAvailabilityResponse, FrontHostHealthResponse, FrontHostMessageResponse, FrontHostProject, FrontHostProjectListResponse, FrontHostProjectVersionsResponse } from "../types/fronthost";
+import { ClientConfig, RequestOptions, PaginatedResponse } from "../types";
+import { FrontHostCreateProjectInput, FrontHostDeployResponse, FrontHostDomainAvailabilityResponse, FrontHostHealthResponse, FrontHostProject, FrontHostProjectVersion } from "../types/fronthost";
 /**
  * HTML 托管网关（gateway_h5 / fronthost）管理 API
  *
  * 部署在 API 网关后面时，建议使用 qing-client 的前端模式（config.gatewayUrl），
  * 这样 BaseClient 会自动加 x-project-id / x-app-id（与 gateway_h5 verifyGatewayToken 一致）。
+ *
+ * 所有接口返回标准 ApiResponse / PaginatedResponse 格式
  */
 export declare class FrontHostService extends BaseClient {
     constructor(config: ClientConfig);
@@ -13,25 +15,31 @@ export declare class FrontHostService extends BaseClient {
     health(options?: RequestOptions): Promise<FrontHostHealthResponse>;
     /** 子域名可用性：GET /domains/available?subdomain=xx */
     checkSubdomainAvailability(subdomain: string, options?: RequestOptions): Promise<FrontHostDomainAvailabilityResponse>;
-    /** 项目列表：GET /projects */
-    listProjects(options?: RequestOptions): Promise<FrontHostProjectListResponse>;
+    /**
+     * 项目列表：GET /projects
+     * 返回分页响应格式
+     */
+    listProjects(options?: RequestOptions): Promise<PaginatedResponse<FrontHostProject>>;
     /** 项目详情：GET /projects/{id} */
     getProject(id: string, options?: RequestOptions): Promise<FrontHostProject>;
     /**
      * 创建项目：POST /projects (multipart/form-data)
-     * - zip 字段名必须是 file（与服务端 r.FormFile("file") 一致）
+     * - zip 或单文件字段名必须是 file（与服务端 r.FormFile("file") 一致）
      * - 其他字段按 deployType 决定传哪些
      */
     createProject(input: FrontHostCreateProjectInput, options?: RequestOptions): Promise<FrontHostProject>;
     /** 删除项目：DELETE /projects/{id} */
-    deleteProject(id: string, options?: RequestOptions): Promise<FrontHostMessageResponse>;
+    deleteProject(id: string, options?: RequestOptions): Promise<void>;
     /**
      * 部署新版本：PUT /projects/{id}/deploy (multipart/form-data)
      * - 文件字段名固定 file
      */
-    deployNewVersion(projectId: string, file: Blob | File, options?: RequestOptions): Promise<FrontHostMessageResponse>;
-    /** 版本列表：GET /projects/{id}/versions */
-    getProjectVersions(projectId: string, options?: RequestOptions): Promise<FrontHostProjectVersionsResponse>;
+    deployNewVersion(projectId: string, file: Blob | File, options?: RequestOptions): Promise<FrontHostDeployResponse>;
+    /**
+     * 版本列表：GET /projects/{id}/versions
+     * 返回分页响应格式
+     */
+    getProjectVersions(projectId: string, options?: RequestOptions): Promise<PaginatedResponse<FrontHostProjectVersion>>;
     /** 回滚版本：POST /projects/{id}/rollback/{version_id} */
-    rollbackVersion(projectId: string, versionId: string, options?: RequestOptions): Promise<FrontHostMessageResponse>;
+    rollbackVersion(projectId: string, versionId: string, options?: RequestOptions): Promise<FrontHostDeployResponse>;
 }

package/lib/service/FrontHostService.js

@@ -8,6 +8,8 @@ const BaseClient_1 = require("../client/BaseClient");
  *
  * 部署在 API 网关后面时，建议使用 qing-client 的前端模式（config.gatewayUrl），
  * 这样 BaseClient 会自动加 x-project-id / x-app-id（与 gateway_h5 verifyGatewayToken 一致）。
+ *
+ * 所有接口返回标准 ApiResponse / PaginatedResponse 格式
  */
 class FrontHostService extends BaseClient_1.BaseClient {
     constructor(config) {
@@ -29,9 +31,12 @@ class FrontHostService extends BaseClient_1.BaseClient {
             params: { subdomain },
         });
     }
-    /** 项目列表：GET /projects */
+    /**
+     * 项目列表：GET /projects
+     * 返回分页响应格式
+     */
     async listProjects(options) {
-        return this.request("/projects", {
+        return this.paginatedRequest("/projects", {
             ...options,
             method: "GET",
         });
@@ -45,7 +50,7 @@ class FrontHostService extends BaseClient_1.BaseClient {
     }
     /**
      * 创建项目：POST /projects (multipart/form-data)
-     * - zip 字段名必须是 file（与服务端 r.FormFile("file") 一致）
+     * - zip 或单文件字段名必须是 file（与服务端 r.FormFile("file") 一致）
      * - 其他字段按 deployType 决定传哪些
      */
     async createProject(input, options) {
@@ -97,9 +102,12 @@ class FrontHostService extends BaseClient_1.BaseClient {
             body: form,
         });
     }
-    /** 版本列表：GET /projects/{id}/versions */
+    /**
+     * 版本列表：GET /projects/{id}/versions
+     * 返回分页响应格式
+     */
     async getProjectVersions(projectId, options) {
-        return this.request(`/projects/${encodeURIComponent(projectId)}/versions`, {
+        return this.paginatedRequest(`/projects/${encodeURIComponent(projectId)}/versions`, {
             ...options,
             method: "GET",
         });

package/lib/types/file.d.ts

@@ -13,6 +13,7 @@ export interface File {
     etag?: string;
     contentMd5?: string;
     folderId?: string | null;
+    uid?: string;
     createdAt: string;
     updatedAt: string;
 }
@@ -42,6 +43,7 @@ export interface FileListQuery {
     folderId?: string;
     taskId?: string;
     acl?: 'private' | 'public-read';
+    uid?: string;
 }
 export interface Folder {
     id: string;
@@ -77,6 +79,15 @@ export interface OSSConfig {
     defaultTask: string;
     isPublic?: boolean;
 }
+export interface TaskOption {
+    value: string;
+    label: string;
+    isPublic?: boolean;
+}
+export interface TaskOptionsResponse {
+    options: TaskOption[];
+    defaultValue: string;
+}
 export interface GenerateOSSUploadSignRequest {
     taskKey?: string;
     fileName?: string;

package/lib/types/fronthost.d.ts

@@ -1,5 +1,5 @@
-/** 部署类型：子域名 / 路由 / 代理域名 */
-export type FrontHostDeployType = "subdomain" | "route" | "proxy";
+/** 部署类型：子域名 / 路由 / 代理域名 / 单文件 */
+export type FrontHostDeployType = "subdomain" | "route" | "proxy" | "file";
 /** 项目（后端返回的视图模型） */
 export interface FrontHostProject {
     id: string;
@@ -14,10 +14,6 @@ export interface FrontHostProject {
     status: string;
     createdAt: string;
 }
-/** 列表接口返回 */
-export interface FrontHostProjectListResponse {
-    projects: FrontHostProject[];
-}
 /** 创建项目：表单字段（文件用 FormData 传） */
 export interface FrontHostCreateProjectInput {
     name?: string;
@@ -29,26 +25,26 @@ export interface FrontHostCreateProjectInput {
     routePath?: string;
     /** proxy 模式 */
     proxyDomain?: string;
-    /** zip 包（字段名必须是 file，与服务端一致） */
+    /** zip 包或单文件（字段名必须是 file，与服务端一致） */
     file: Blob | File;
 }
-/** 版本信息（根据你们服务端 models.ProjectVersion 常见字段做的贴合注解）
- *  如果服务端字段与你们实际不一致，把这里字段名对齐即可
- */
+/** 版本信息 */
 export interface FrontHostProjectVersion {
     id: string;
     projectId: string;
     versionNumber: number;
     isActive: boolean;
     deployedAt: string;
+    createdAt?: string;
 }
-/** 获取项目版本列表 */
-export interface FrontHostProjectVersionsResponse {
-    versions: FrontHostProjectVersion[];
-}
-/** 回滚/删除等简单操作 */
-export interface FrontHostMessageResponse {
-    message: string;
+/** 部署/回滚响应中的数据 */
+export interface FrontHostDeployResponse {
+    version: FrontHostProjectVersion;
+    project: {
+        id: string;
+        name: string;
+        url: string;
+    };
 }
 /** 域名/子域名可用性 */
 export interface FrontHostDomainAvailabilityResponse {
@@ -60,3 +56,15 @@ export interface FrontHostHealthResponse {
     status: "ok" | string;
     timestamp: string;
 }
+/** @deprecated 使用 PaginatedResponse<FrontHostProject[]> 替代 */
+export interface FrontHostProjectListResponse {
+    projects: FrontHostProject[];
+}
+/** @deprecated 使用 PaginatedResponse<FrontHostProjectVersion[]> 替代 */
+export interface FrontHostProjectVersionsResponse {
+    versions: FrontHostProjectVersion[];
+}
+/** @deprecated 使用 ApiResponse 替代 */
+export interface FrontHostMessageResponse {
+    message: string;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "qing-client",
-  "version": "0.0.25",
+  "version": "0.0.27",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "scripts": {