ace-front-end 1.0.0

package/ace-app-bolts-ui/src/models/fileService/index.ts

@@ -0,0 +1,1060 @@
+import type {EntityBase} from "../EntityBase";
+
+/**
+ * 文件数量溢出策略
+ */
+export enum CountOverflowStrategy {
+    /**
+     * 替换第一个文件
+     */
+    REPLACE_FIRST = "REPLACE_FIRST",
+    /**
+     * 替换最后一个文件
+     */
+    REPLACE_LAST = "REPLACE_LAST",
+    /**
+     * 抛出异常
+     */
+    THROW_ERROR = "THROW_ERROR",
+}
+
+/**
+ * 文件WebHook类型
+ */
+export enum FileWebhookType {
+    /**
+     * 上传保存之前
+     */
+    UPLOADING = "UPLOADING",
+    /**
+     * 下载之前
+     */
+    DOWNLOADING = "DOWNLOADING",
+    /**
+     * 删除之前
+     */
+    DELETING = "DELETING",
+    /**
+     * 预览之前
+     */
+    PREVIEWING = "PREVIEWING",
+}
+
+/**
+ * 文件Webhook事件定义
+ */
+export interface FileWebHook extends EntityBase {
+    /**
+     * 排序号
+     */
+    sortIndex: number;
+    /**
+     * 文件事件钩子类型
+     */
+    webhookType: FileWebhookType;
+    /**
+     * 文件事件钩子url
+     */
+    hookUrl: string;
+}
+
+export type WebcamMode = "VIDEO_AUDIO" | "VIDEO_ONLY" | "PICTURE";
+
+/**
+ * 附件配置
+ */
+export interface FileConfiguration {
+    /**
+     * 主键
+     */
+    id: string;
+    /**
+     * 数据版本
+     */
+    dataVersion: number;
+    /**
+     * 应用名
+     */
+    appName: string;
+    /**
+     * 应用服务名
+     */
+    appServiceName: string;
+    /**
+     * 配置键
+     */
+    configKey: string;
+    /**
+     * 允许上传的文件类型
+     */
+    accept?: string;
+    /**
+     * 最大文件数，默认0表示不限制
+     */
+    maxFileCount?: number;
+    /**
+     * 文件数量溢出处理策略
+     */
+    countOverflowStrategy: CountOverflowStrategy;
+    /**
+     * 最大单个文件大小，默认0表示不限制
+     */
+    maxSingleFileSize?: number;
+    /**
+     * 所有文件总大小，默认0表示不限制
+     */
+    maxTotalFileSize?: number;
+    /**
+     * 是否加密存储
+     */
+    enableEncrypt?: boolean;
+    /**
+     * 加密算法
+     */
+    encAlgorithm: string;
+    /**
+     * 允许最大加密文件大小，超出此大小的文件将不再加密
+     */
+    maxEncryptSize?: string;
+    /**
+     * 上传说明
+     */
+    uploadNote?: string;
+    /**
+     * 文件切片大小
+     */
+    chunkSize: number;
+    /**
+     * 禁止上传文件夹（禁止用户选择本地文件夹上传）
+     */
+    disableDirUpload: boolean;
+    /**
+     * 禁止上传文件（禁止用户选择本机文件上传）
+     */
+    disableFileUpload: boolean;
+    /**
+     * 启用摄像头作为文件输入源(上传拍摄的照片或录像)
+     */
+    enableWebcam: boolean;
+    /**
+     * 工作模式
+     */
+    allowedWebcamModes: WebcamMode[];
+    /**
+     * 启用录音机（上传录音文件）
+     */
+    enableAudio: boolean;
+    /**
+     * 启用截屏（上传截屏文件或录屏视频）
+     */
+    enableScreenCapture: boolean;
+    /**
+     * 启用密级
+     */
+    enableClassifiedLevel: boolean;
+    /**
+     * 允许上传
+     */
+    disallowUpload: boolean;
+    /**
+     * 允许删除
+     */
+    disallowDelete: boolean;
+    /**
+     * 允许下载
+     */
+    disallowDownload: boolean;
+    /**
+     * 上传权限名
+     */
+    uploadAuthCode: string;
+    /**
+     * 允许删除权限名
+     */
+    deleteAuthCode: string;
+    /**
+     * 允许下载权限名
+     */
+    downloadAuthCode: string;
+    /**
+     * 允许删除他人上传的文件
+     */
+    allowDeleteOthersFile: boolean;
+    /**
+     * 设置要存储备份集
+     */
+    backupSet: string;
+    /**
+     * 路径格式
+     */
+    subDirFormat: string;
+    /**
+     * 禁用预览
+     */
+    disablePreview?: boolean;
+    /**
+     * 是否启用预览水印
+     */
+    enablePreviewWatermark?: boolean;
+    /**
+     * 水印文本，支持使用el表达式
+     */
+    watermark?: string;
+    /**
+     * 是否公共文件，无需登录即可下载
+     */
+    isPublic: boolean;
+    /**
+     * 每个用户的默认配额，为空或0表示无限配额
+     */
+    defaultQuota: string;
+    /**
+     * 文件事件钩子
+     */
+    webhooks: FileWebHook[];
+}
+
+export interface FileStorage {
+    /**
+     * 主键
+     */
+    id: string;
+    /**
+     * 数据版本
+     */
+    dataVersion: number;
+    /**
+     * 存储库标识
+     */
+    repositoryKey: string;
+    /**
+     * 存储库最大容量
+     */
+    maxSize: number;
+    /**
+     * 存储库已占用容量
+     */
+    usedSize: number;
+    /**
+     * 存储库告警容量
+     */
+    warningPercentage: number;
+    /**
+     * 所属的备份集
+     */
+    backupSet: string;
+    /**
+     * 是否为只读库
+     */
+    readonly: boolean;
+    /**
+     * 存储库提供程序
+     */
+    storageProvider: string;
+    /**
+     * 存储库提供程序配置参数
+     */
+    providerSettings: {
+        [key: string]: string;
+    };
+}
+
+/**
+ * 文件信息
+ */
+export interface FileInfo {
+    /**
+     * 文件ID
+     */
+    id: string;
+    /**
+     * 附件配置Id
+     */
+    configId: string;
+    /**
+     * 文件名
+     */
+    fileName: string;
+    /**
+     * 上传人id
+     */
+    uploaderId: string;
+    /**
+     * 上传人姓名
+     */
+    uploaderName: string;
+    /**
+     * 上传时间
+     */
+    uploadTime: string;
+    /**
+     * 文件密级
+     */
+    classifiedLevel: number;
+    /**
+     * 文件类型
+     */
+    contentType: string;
+    /**
+     * 文件大小(原始大小）
+     */
+    fileSize: number;
+    /**
+     * 是否已经附加
+     */
+    attached: boolean;
+    /**
+     * 文件哈希值
+     */
+    checksum: string;
+    /**
+     * 临时下载令牌
+     */
+    token: string;
+}
+
+/**
+ * 用户存储空间配额
+ */
+export interface FileQuota {
+    id: string;
+    /**
+     * 用户Id
+     */
+    userId: string;
+    /**
+     * 用户名
+     */
+    username: string;
+    /**
+     * 用户姓名
+     */
+    userFullName: string;
+    /**
+     * 配额大小
+     */
+    quotaSize: number;
+    /**
+     * 已使用空间
+     */
+    usedSize: number;
+    /**
+     * 文件配置Id
+     */
+    configurationId: string;
+}
+
+/**
+ * 已经与全局和应用配置合并后的最终文件配置值
+ */
+export interface MergedFileConfig {
+    id: string;
+
+    appName: string;
+
+    appServiceName: string;
+
+    configKey: string;
+    /**
+     * 允许上传的文件类型
+     */
+    accept: string;
+    /**
+     * 最大文件数，默认0表示不限制
+     */
+    maxFileCount: number;
+    /**
+     * 文件数量溢出处理策略
+     */
+    countOverflowStrategy: CountOverflowStrategy;
+    /**
+     * 最大单个文件大小，默认0表示不限制
+     */
+    maxSingleFileSize: string;
+    /**
+     * 所有文件总大小，默认0表示不限制
+     */
+    maxTotalFileSize: string;
+    /**
+     * 禁止上传文件夹（禁止用户选择本地文件夹上传）
+     */
+    disableDirUpload?: boolean;
+    /**
+     * 禁止上传文件（禁止用户选择本机文件上传）
+     */
+    disableFileUpload?: boolean;
+    /**
+     * 上传说明
+     */
+    uploadNote?: string;
+    /**
+     * 启用摄像头作为文件输入源(上传拍摄的照片或录像)
+     */
+    enableWebcam?: boolean;
+    /**
+     * 工作模式
+     */
+    allowedWebcamModes?: WebcamMode[];
+    /**
+     * 启用录音机（上传录音文件）
+     */
+    enableAudio?: boolean;
+    /**
+     * 启用截屏（上传截屏文件或录屏视频）
+     */
+    enableScreenCapture?: boolean;
+    /**
+     * 启用密级
+     */
+    enableClassifiedLevel: boolean;
+    /**
+     * 允许上传
+     */
+    disallowUpload: boolean;
+    /**
+     * 允许删除
+     */
+    disallowDelete: boolean;
+    /**
+     * 允许下载
+     */
+    disallowDownload: boolean;
+    /**
+     * 切片大小
+     */
+    chunkSize: number;
+    /**
+     * 禁用预览
+     */
+    disablePreview: boolean;
+    /**
+     * 上传权限名
+     */
+    uploadAuthCode: string;
+    /**
+     * 允许删除权限名
+     */
+    deleteAuthCode: string;
+    /**
+     * 允许下载权限名
+     */
+    downloadAuthCode: string;
+    /**
+     * 允许删除他人上传的文件
+     */
+    allowDeleteOthersFile: boolean;
+    /**
+     * 是否公共文件，无需登录即可下载
+     */
+    isPublic: boolean;
+}
+
+export interface FileConfigurationReference {
+    /**
+     * 主键
+     */
+    id: string;
+}
+
+/**
+ * 附件配置投影
+ */
+export interface ProjectedFileConfiguration {
+    /**
+     * 主键
+     */
+    id: string;
+    /**
+     * 数据版本
+     */
+    dataVersion: number;
+    /**
+     * 应用服务名
+     */
+    appServiceName: string;
+
+    /**
+     * 应用名
+     */
+    appName: string;
+    /**
+     * 配置键
+     */
+    configKey: string;
+    /**
+     * 允许上传的文件类型
+     */
+    accept?: string;
+    /**
+     * 最大文件数，默认0表示不限制
+     */
+    maxFileCount?: number;
+    /**
+     * 最大单个文件大小，默认0表示不限制
+     */
+    maxSingleFileSize?: string;
+    /**
+     * 所有文件总大小，默认0表示不限制
+     */
+    maxTotalFileSize?: string;
+    /**
+     * 是否加密存储
+     */
+    enableEncrypt?: boolean;
+    /**
+     * 启用密级
+     */
+    enableClassifiedLevel: boolean;
+    /**
+     * 允许上传
+     */
+    disallowUpload: boolean;
+    /**
+     * 允许删除
+     */
+    disallowDelete: boolean;
+    /**
+     * 允许下载
+     */
+    disallowDownload: boolean;
+    /**
+     * 是否公开文件
+     */
+    isPublic: boolean;
+    /**
+     * 禁用预览
+     */
+    disablePreview: boolean;
+    /**
+     * 设置要存储备份集
+     */
+    backupSet: string;
+}
+
+/**
+ * 文件存储库定义投影
+ */
+export interface ProjectedFileStorage {
+    /**
+     * 主键
+     */
+    id: string;
+    /**
+     * 数据版本
+     */
+    dataVersion: number;
+    /**
+     * 存储库标识
+     */
+    repositoryKey: string;
+    /**
+     * 存储库最大容量
+     */
+    maxSize: number;
+    /**
+     * 存储库已占用容量
+     */
+    usedSize: number;
+    /**
+     * 存储库告警容量
+     */
+    warningPercentage: number;
+    /**
+     * 是否只读
+     */
+    readonly: boolean;
+    /**
+     * 所属的备份集
+     */
+    backupSet: string;
+    /**
+     * 存储库提供程序
+     */
+    storageProvider: string;
+}
+
+/**
+ * 上传组件初始化参数
+ */
+export interface UploadInitParams {
+    /**
+     * 切片大小
+     */
+    chunkSize: number;
+    /**
+     * 附件id
+     */
+    attachId: string;
+    /**s
+     * 附件令牌
+     */
+    attachToken: string;
+    /**
+     * 附件配置
+     */
+    fileConfig: MergedFileConfig;
+    /**
+     * 已上传的文件列表
+     */
+    files: FileInfo[];
+}
+
+/**
+ * 创建附件配置命令
+ */
+export interface CreateFileConfigurationCommand {
+    /**
+     * 应用名
+     */
+    appName: string;
+
+    /**
+     * 服务名
+     */
+    appServiceName: string;
+    /**
+     * 配置标识
+     */
+    configKey: string;
+    /**
+     * 允许上传的文件类型
+     */
+    accept?: string;
+    /**
+     * 最大文件数，默认0表示不限制
+     */
+    maxFileCount?: number;
+    /**
+     * 文件数量溢出处理策略
+     */
+    countOverflowStrategy: CountOverflowStrategy;
+    /**
+     * 最大单个文件大小，默认0表示不限制
+     */
+    maxSingleFileSize?: number;
+    /**
+     * 所有文件总大小，默认0表示不限制
+     */
+    maxTotalFileSize?: number;
+    /**
+     * 是否加密存储
+     */
+    enableEncrypt?: number | boolean;
+    /**
+     * 加密算法
+     */
+    encAlgorithm?: string;
+    /**
+     * 允许最大加密文件大小，超出此大小的文件将不再加密
+     */
+    maxEncryptSize?: number;
+    /**
+     * 上传说明
+     */
+    uploadNote?: string;
+    /**
+     * 文件切片大小
+     */
+    chunkSize?: number;
+    /**
+     * 禁止上传文件夹（禁止用户选择本地文件夹上传）
+     */
+    disableDirUpload?: boolean;
+    /**
+     * 禁止上传文件（禁止用户选择本机文件上传）
+     */
+    disableFileUpload?: boolean;
+    /**
+     * 启用摄像头作为文件输入源(上传拍摄的照片或录像)
+     */
+    enableWebcam?: boolean;
+    /**
+     * 工作模式
+     */
+    allowedWebcamModes?: WebcamMode[];
+    /**
+     * 启用录音机（上传录音文件）
+     */
+    enableAudio?: boolean;
+    /**
+     * 启用截屏（上传截屏文件或录屏视频）
+     */
+    enableScreenCapture?: boolean;
+    /**
+     * 启用密级
+     */
+    enableClassifiedLevel?: boolean;
+    /**
+     * 允许上传
+     */
+    disallowUpload?: boolean;
+    /**
+     * 允许删除
+     */
+    disallowDelete?: boolean;
+    /**
+     * 允许下载
+     */
+    disallowDownload?: boolean;
+    /**
+     * 上传权限名
+     */
+    uploadAuthCode?: string;
+    /**
+     * 允许删除权限名
+     */
+    deleteAuthCode?: string;
+    /**
+     * 允许下载权限名
+     */
+    downloadAuthCode?: string;
+    /**
+     * 允许删除他人上传的文件
+     */
+    allowDeleteOthersFile?: boolean;
+    /**
+     * 设置要存储备份集
+     */
+    backupSet: string;
+    /**
+     * 路径格式
+     */
+    subDirFormat: string;
+    /**
+     * 禁用预览
+     */
+    disablePreview?: boolean | number;
+    /**
+     * 是否启用预览水印
+     */
+    enablePreviewWatermark?: boolean | number;
+    /**
+     * 水印文本，支持使用el表达式
+     */
+    watermark?: string;
+    /**
+     * 每个用户的默认配额，为空或0表示无限配额
+     */
+    defaultQuota?: string;
+    /**
+     * 是否公共文件，无需登录即可下载
+     */
+    isPublic?: boolean;
+}
+
+/**
+ * 创建文件存储库命令
+ */
+export interface CreateFileStorageCommand {
+    /**
+     * 存储库标识
+     */
+    repositoryKey: string;
+    /**
+     * 存储库最大容量
+     */
+    maxSize: number;
+    /**
+     * 是否为只读库
+     */
+    readonly: boolean;
+    /**
+     * 存储库告警容量
+     */
+    warningPercentage: number;
+    /**
+     * 所属的备份集
+     */
+    backupSet: string;
+    /**
+     * 存储库提供程序
+     */
+    storageProvider: string;
+
+    /**
+     * 存储库提供程序配置参数
+     */
+    providerSettings: {
+        [key: string]: string;
+    };
+}
+
+/**
+ * 创建文件Webhook命令
+ */
+export interface CreateFileWebHookCommand {
+    /**
+     * 附件配置id
+     */
+    fileConfiguration: FileConfigurationReference;
+    /**
+     * 排序号
+     */
+    sortIndex: number;
+    /**
+     * 文件事件钩子类型
+     */
+    webhookType: FileWebhookType;
+    /**
+     * 文件事件钩子 url
+     */
+    hookUrl: string;
+}
+
+/**
+ * 删除文件配置命令
+ */
+export interface DeleteFileConfigurationCommand {
+    /**
+     * 主键
+     */
+    id: string;
+    /**
+     * 数据版本
+     */
+    dataVersion: number;
+}
+
+/**
+ * 删除文件存储库命令
+ */
+export interface DeleteFileStorageCommand {
+    /**
+     * 主键
+     */
+    id: string;
+    /**
+     * 数据版本
+     */
+    dataVersion: number;
+}
+
+/**
+ * 删除文件WebHook命令
+ */
+export interface DeleteFileWebHookCommand {
+    /**
+     * 主键
+     */
+    id: string;
+    /**
+     * 数据版本
+     */
+    dataVersion: number;
+}
+
+/**
+ * 管理员管理附件配置命令
+ */
+export interface ManageFileConfigurationCommand {
+    /**
+     * 附件配置id
+     */
+    id: string;
+    /**
+     * 数据版本号
+     */
+    dataVersion: number;
+    /**
+     * 允许上传的文件类型
+     */
+    accept: string;
+    /**
+     * 最大文件数，默认0表示不限制
+     */
+    maxFileCount: number;
+    /**
+     * 文件数量溢出处理策略
+     */
+    countOverflowStrategy: CountOverflowStrategy;
+    /**
+     * 最大单个文件大小，默认0表示不限制
+     */
+    maxSingleFileSize: number;
+    /**
+     * 所有文件总大小，默认0表示不限制
+     */
+    maxTotalFileSize: number;
+    /**
+     * 是否加密存储
+     */
+    enableEncrypt: boolean;
+    /**
+     * 加密算法
+     */
+    encAlgorithm: string;
+    /**
+     * 允许最大加密文件大小，超出此大小的文件将不再加密
+     */
+    maxEncryptSize: number;
+    /**
+     * 启用密级
+     */
+    enableClassifiedLevel?: boolean;
+    /**
+     * 上传说明
+     */
+    uploadNote?: string;
+    /**
+     * 文件切片大小
+     */
+    chunkSize?: number;
+    /**
+     * 禁止上传文件夹（禁止用户选择本地文件夹上传）
+     */
+    disableDirUpload?: boolean;
+    /**
+     * 禁止上传文件（禁止用户选择本机文件上传）
+     */
+    disableFileUpload?: boolean;
+    /**
+     * 启用摄像头作为文件输入源(上传拍摄的照片或录像)
+     */
+    enableWebcam?: boolean;
+    /**
+     * 工作模式
+     */
+    allowedWebcamModes?: WebcamMode[];
+    /**
+     * 启用录音机（上传录音文件）
+     */
+    enableAudio?: boolean;
+    /**
+     * 启用截屏（上传截屏文件或录屏视频）
+     */
+    enableScreenCapture?: boolean;
+    /**
+     * 允许上传
+     */
+    disallowUpload?: boolean;
+    /**
+     * 允许删除
+     */
+    disallowDelete?: boolean;
+    /**
+     * 允许下载
+     */
+    disallowDownload?: boolean;
+    /**
+     * 上传权限名
+     */
+    uploadAuthCode?: string;
+    /**
+     * 允许删除权限名
+     */
+    deleteAuthCode?: string;
+    /**
+     * 允许下载权限名
+     */
+    downloadAuthCode?: string;
+    /**
+     * 允许删除他人上传的文件
+     */
+    allowDeleteOthersFile?: boolean;
+    /**
+     * 路径格式
+     */
+    subDirFormat: string;
+    /**
+     * 禁用预览
+     */
+    disablePreview?: boolean;
+    /**
+     * 是否启用预览水印
+     */
+    enablePreviewWatermark?: boolean;
+    /**
+     * 水印文本，支持使用el表达式
+     */
+    watermark?: string;
+    /**
+     * 每个用户的默认配额，为空或0表示无限配额
+     */
+    defaultQuota?: string;
+    /**
+     * 是否公共文件，无需登录即可下载
+     */
+    isPublic?: boolean;
+}
+
+/**
+ * 更新附件配置命令
+ */
+export interface UpdateFileConfigurationCommand extends CreateFileConfigurationCommand {
+    /**
+     * 主键
+     */
+    id: string;
+    /**
+     * 数据版本
+     */
+    dataVersion: number;
+}
+
+/**
+ * 更新用户的附件存储配额
+ */
+export interface UpdateFileQuotaCommand {
+    /**
+     * 用户id
+     */
+    userId: string;
+    /**
+     * 文件配置id
+     */
+    fileConfigId: string;
+    /**
+     * 配额值
+     */
+    quota: string;
+}
+
+/**
+ * 修改文件存储库
+ */
+export interface UpdateFileStorageCommand extends CreateFileStorageCommand {
+    /**
+     * 主键
+     */
+    id: string;
+    /**
+     * 数据版本
+     */
+    dataVersion: number;
+}
+
+/**
+ * 更新文件webhook定义
+ */
+export interface UpdateFileWebHookCommand extends CreateFileWebHookCommand {
+    /**
+     * 主键
+     */
+    id: string;
+    /**
+     * 数据版本
+     */
+    dataVersion: number;
+}
+
+/**
+ * 存储库提供程序属性定义元数据
+ */
+export interface RepositoryProviderPropertyMeta {
+    /**
+     * 属性名
+     */
+    name: string;
+    /**
+     * 属性标题
+     */
+    caption: string;
+    /**
+     * 属性帮助文本
+     */
+    helpText: string;
+    /**
+     * 是否必填
+     */
+    required: boolean;
+}