smart-admin-web 10.26.0 → 10.28.0

package/dist/api/index.d.ts

@@ -637,6 +637,169 @@ export declare const fileApi: {
         chunkCount: number;
     }) => Promise<FileUploadOutput>;
 };
+export type FileServerView = components['schemas']['FileServerView'];
+export type FileServerSaveInput = components['schemas']['FileServerSaveInput'];
+export type FileServerTestInput = components['schemas']['FileServerTestInput'];
+export type FileServerOption = components['schemas']['FileServerOption'];
+export type FileAccessTestResult = components['schemas']['FileAccessTestResult'];
+export type FileAccessStatus = components['schemas']['FileAccessStatus'];
+export type FilePathView = components['schemas']['FilePathView'];
+export type FilePathAddInput = components['schemas']['FilePathAddInput'];
+export type FilePathUpdateInput = components['schemas']['FilePathUpdateInput'];
+export type FilePathTestInput = components['schemas']['FilePathTestInput'];
+export type FilePathEnvironment = components['schemas']['FilePathEnvironment'];
+export type FilePathUploadOutput = components['schemas']['FilePathUploadOutput'];
+/** 分片初始化出参:契约里 int32 写作 number | string,线上实际是数字,这里收窄成 number 供切片计算。 */
+export interface FilePathChunkInitOutput {
+    uploadId: string;
+    chunkSize: number;
+    chunkCount: number;
+}
+export declare const fileServerApi: {
+    /** 文件服务器分页;keyword 模糊匹配名称或根路径。 */
+    page: (params: {
+        page: number;
+        pageSize: number;
+        keyword?: string;
+        enabled?: boolean;
+    }) => Promise<{
+        items: {
+            id: number | string;
+            name: string;
+            rootPath: string;
+            userName: null | string;
+            hasPassword: boolean;
+            enabled: boolean;
+            remark: null | string;
+        }[];
+        total: number;
+    }>;
+    get: (id: number) => Promise<{
+        id: number | string;
+        name: string;
+        rootPath: string;
+        userName: null | string;
+        hasPassword: boolean;
+        enabled: boolean;
+        remark: null | string;
+    }>;
+    add: (body: FileServerSaveInput) => Promise<number>;
+    update: (id: number, body: FileServerSaveInput) => Promise<boolean>;
+    remove: (id: number) => Promise<boolean>;
+    /** 测试连接:用表单里当前填的值,不要求先保存;失败原因在返回体里,不抛异常。 */
+    test: (body: FileServerTestInput) => Promise<{
+        ok: boolean;
+        reason: null | string;
+        latencyMs: number | string;
+    }>;
+    /** 一批文件服务器的在线状态;不缓存,每次现连。 */
+    status: (ids: number[]) => Promise<{
+        id: number | string;
+        online: boolean;
+        reason: null | string;
+    }[]>;
+    /** 下拉选项(配文件路径时选服务器)。 */
+    options: () => Promise<{
+        id: number | string;
+        name: string;
+        rootPath: string;
+        enabled: boolean;
+    }[]>;
+};
+export declare const filePathApi: {
+    /** 文件路径分页;keyword 模糊匹配编码或名称。 */
+    page: (params: {
+        page: number;
+        pageSize: number;
+        keyword?: string;
+        serverId?: number;
+        enabled?: boolean;
+    }) => Promise<{
+        items: {
+            id: number | string;
+            code: string;
+            name: string;
+            serverId: number | string;
+            serverName: null | string;
+            folder: null | string;
+            namingRule: components["schemas"]["FilePathNamingRule"];
+            onConflict: components["schemas"]["FilePathConflictMode"];
+            readOnly: boolean;
+            allowedExtensions: null | string;
+            maxSizeMb: null | number | string;
+            uploadRoleIds: (number | string)[];
+            downloadRoleIds: (number | string)[];
+            enabled: boolean;
+            remark: null | string;
+        }[];
+        total: number;
+    }>;
+    get: (id: number) => Promise<{
+        id: number | string;
+        code: string;
+        name: string;
+        serverId: number | string;
+        serverName: null | string;
+        folder: null | string;
+        namingRule: components["schemas"]["FilePathNamingRule"];
+        onConflict: components["schemas"]["FilePathConflictMode"];
+        readOnly: boolean;
+        allowedExtensions: null | string;
+        maxSizeMb: null | number | string;
+        uploadRoleIds: (number | string)[];
+        downloadRoleIds: (number | string)[];
+        enabled: boolean;
+        remark: null | string;
+    }>;
+    add: (body: FilePathAddInput) => Promise<number>;
+    /** 编码是业务引用它的键,保存后不能改,所以更新入参里没有 code。 */
+    update: (id: number, body: FilePathUpdateInput) => Promise<boolean>;
+    remove: (id: number) => Promise<boolean>;
+    /** 测试连接:用弹窗里当前选的服务器、子文件夹和读写方式,不要求先保存。 */
+    test: (body: FilePathTestInput) => Promise<{
+        ok: boolean;
+        reason: null | string;
+        latencyMs: number | string;
+    }>;
+    /** 一批文件路径的在线状态;不缓存,每次现连。 */
+    status: (ids: number[]) => Promise<{
+        id: number | string;
+        online: boolean;
+        reason: null | string;
+    }[]>;
+    /** 配置页的环境信息:白名单根目录,以及当前平台能不能用账号连接共享。 */
+    environment: () => Promise<{
+        allowedRoots: string[];
+        supportsCredentials: boolean;
+    }>;
+};
+export declare const filePathFileApi: {
+    /** 单文件上传:返回相对文件夹的路径,业务存它、之后凭它下载。subPath 仅「业务指定路径」命名规则用。 */
+    upload: (code: string, file: File, subPath?: string, signal?: AbortSignal) => Promise<{
+        path: string;
+        name: string;
+        size: number | string;
+        viewUrl?: null | string;
+    }>;
+    /** 分片初始化:服务端按声明的文件名、大小拦规则,通过才建暂存会话,分片大小与片数以它返回的为准。 */
+    chunkInit: (code: string, input: {
+        fileName: string;
+        size: number;
+        sha256: string;
+        subPath?: string;
+    }, signal?: AbortSignal) => Promise<FilePathChunkInitOutput>;
+    /** 上传一个分片(multipart:uploadId + index + chunk),同 upload 用 bodySerializer 建 FormData。 */
+    chunk: (code: string, uploadId: string, index: number, blob: Blob, signal?: AbortSignal) => Promise<void>;
+    /** 完成:服务端合并、按实际大小和当前规则再校验、核对哈希后写入。 */
+    chunkComplete: (code: string, uploadId: string, signal?: AbortSignal) => Promise<{
+        path: string;
+        name: string;
+        size: number | string;
+        viewUrl?: null | string;
+    }>;
+    /** 下载:parseAs blob 取原始字节;业务失败服务端回 200 + 信封,unwrapDownload 会辨出来抛 ApiError。 */
+    download: (code: string, path: string, name?: string) => Promise<Blob>;
+};
 export declare const sessionApi: {
     /** 在线会话分页(只读)。后端仅支持按 UserId 过滤,这里不带业务搜索。 */
     online: (params: {