sa2kit 3.0.0 → 3.2.0

package/dist/utils-Dm3O1rAa.d.ts

@@ -0,0 +1,366 @@
+/**
+ * 通用导出服务类型定义
+ *
+ * 定义了导出功能的核心接口和类型
+ */
+/** 导出格式类型 */
+type ExportFormat = 'csv' | 'excel' | 'json';
+/** 字段类型 */
+type FieldType = 'string' | 'number' | 'date' | 'boolean' | 'array' | 'object';
+/** 字段对齐方式 */
+type FieldAlignment = 'left' | 'center' | 'right';
+/** 导出状态 */
+type ExportStatus = 'pending' | 'processing' | 'completed' | 'failed' | 'cancelled';
+/** 分组模式 */
+type GroupingMode = 'merge' | 'separate' | 'nested';
+/** 分组处理类型 */
+type GroupValueProcessing = 'first' | 'last' | 'concat' | 'sum' | 'count' | 'custom';
+/** 导出字段定义 */
+interface ExportField {
+    /** 字段键名 */
+    key: string;
+    /** 字段显示名称 */
+    label: string;
+    /** 字段类型 */
+    type: FieldType;
+    /** 是否启用 */
+    enabled: boolean;
+    /** 字段宽度 */
+    width?: number;
+    /** 对齐方式 */
+    alignment?: FieldAlignment;
+    /** 格式化函数 */
+    formatter?: (value: any) => string;
+    /** 排序权重 */
+    sortOrder?: number;
+    /** 是否必填 */
+    required?: boolean;
+    /** 字段描述 */
+    description?: string;
+    /** 自定义样式 */
+    style?: Record<string, any>;
+}
+/** 分组字段配置 */
+interface GroupingField {
+    /** 分组字段键名 */
+    key: string;
+    /** 分组字段显示名称 */
+    label: string;
+    /** 分组模式 */
+    mode: GroupingMode;
+    /** 其他字段的值处理方式 */
+    valueProcessing: GroupValueProcessing;
+    /** 自定义处理函数 */
+    customProcessor?: (values: any[]) => any;
+    /** 是否显示分组行 */
+    showGroupHeader: boolean;
+    /** 分组行模板 */
+    groupHeaderTemplate?: string;
+    /** 是否合并单元格（仅Excel格式支持） */
+    mergeCells: boolean;
+}
+/** 分组配置 */
+interface GroupingConfig {
+    /** 是否启用分组 */
+    enabled: boolean;
+    /** 分组字段列表（支持多级分组） */
+    fields: GroupingField[];
+    /** 分组后是否保持原始顺序 */
+    preserveOrder: boolean;
+    /** 空值处理方式 */
+    nullValueHandling: 'skip' | 'group' | 'separate';
+    /** 空值分组名称 */
+    nullGroupName?: string;
+}
+/** 导出配置 */
+interface ExportConfig {
+    /** 配置ID */
+    id: string;
+    /** 配置名称 */
+    name: string;
+    /** 配置描述 */
+    description?: string;
+    /** 导出格式 */
+    format: ExportFormat;
+    /** 字段定义 */
+    fields: ExportField[];
+    /** 分组配置 */
+    grouping?: GroupingConfig;
+    /** 文件名模板 */
+    fileNameTemplate: string;
+    /** 是否包含表头 */
+    includeHeader: boolean;
+    /** 分隔符 */
+    delimiter: string;
+    /** 编码格式 */
+    encoding: string;
+    /** 是否添加BOM */
+    addBOM: boolean;
+    /** 最大行数限制 */
+    maxRows?: number;
+    /** 创建时间 */
+    createdAt: Date;
+    /** 更新时间 */
+    updatedAt: Date;
+    /** 模块标识 */
+    moduleId: string;
+    /** 业务标识 */
+    businessId?: string;
+    /** 创建者ID */
+    createdBy?: string;
+}
+/** 导出请求 */
+interface ExportRequest {
+    /** 导出配置ID或配置对象 */
+    configId: string | ExportConfig;
+    /** 数据源 */
+    dataSource: string | (() => Promise<any[]>) | any[];
+    /** 查询参数 */
+    queryParams?: Record<string, any>;
+    /** 自定义字段映射 */
+    fieldMapping?: Record<string, string>;
+    /** 过滤条件 */
+    filters?: ExportFilter[];
+    /** 排序条件 */
+    sortBy?: ExportSort[];
+    /** 分页参数 */
+    pagination?: {
+        page: number;
+        pageSize: number;
+    };
+    /** 自定义文件名 */
+    customFileName?: string;
+    /** 回调函数 */
+    callbacks?: {
+        onProgress?: (progress: ExportProgress) => void;
+        onSuccess?: (result: ExportResult) => void;
+        onError?: (error: ExportError) => void;
+    };
+}
+/** 导出过滤器 */
+interface ExportFilter {
+    /** 字段名 */
+    field: string;
+    /** 操作符 */
+    operator: 'eq' | 'ne' | 'gt' | 'gte' | 'lt' | 'lte' | 'contains' | 'startsWith' | 'endsWith' | 'in' | 'notIn';
+    /** 值 */
+    value: any;
+}
+/** 导出排序 */
+interface ExportSort {
+    /** 字段名 */
+    field: string;
+    /** 排序方向 */
+    direction: 'asc' | 'desc';
+}
+/** 导出进度 */
+interface ExportProgress {
+    /** 导出ID */
+    exportId: string;
+    /** 状态 */
+    status: ExportStatus;
+    /** 进度百分比 */
+    progress: number;
+    /** 已处理行数 */
+    processedRows: number;
+    /** 总行数 */
+    totalRows: number;
+    /** 开始时间 */
+    startTime: Date;
+    /** 预计完成时间 */
+    estimatedEndTime?: Date;
+    /** 当前处理的数据 */
+    currentData?: any;
+    /** 错误信息 */
+    error?: string;
+}
+/** 导出结果 */
+interface ExportResult {
+    /** 导出ID */
+    exportId: string;
+    /** 文件名 */
+    fileName: string;
+    /** 文件大小 */
+    fileSize: number;
+    /** 文件URL */
+    fileUrl?: string;
+    /** 文件Blob */
+    fileBlob?: Blob;
+    /** 导出行数 */
+    exportedRows: number;
+    /** 开始时间 */
+    startTime: Date;
+    /** 完成时间 */
+    endTime: Date;
+    /** 耗时(毫秒) */
+    duration: number;
+    /** 统计信息 */
+    statistics?: {
+        totalRows: number;
+        filteredRows: number;
+        exportedRows: number;
+        skippedRows: number;
+    };
+}
+/** 导出错误 */
+interface ExportError {
+    /** 错误代码 */
+    code: string;
+    /** 错误消息 */
+    message: string;
+    /** 错误详情 */
+    details?: Record<string, any>;
+    /** 错误时间 */
+    timestamp: Date;
+}
+/** 通用导出服务配置 */
+interface UniversalExportServiceConfig {
+    /** 默认导出格式 */
+    defaultFormat: ExportFormat;
+    /** 默认分隔符 */
+    defaultDelimiter: string;
+    /** 默认编码 */
+    defaultEncoding: string;
+    /** 是否默认添加BOM */
+    defaultAddBOM: boolean;
+    /** 最大文件大小限制(字节) */
+    maxFileSize: number;
+    /** 最大行数限制 */
+    maxRowsLimit: number;
+    /** 并发导出数量限制 */
+    maxConcurrentExports: number;
+    /** 导出超时时间(毫秒) */
+    exportTimeout: number;
+    /** 缓存配置 */
+    cache: {
+        /** 配置缓存TTL(秒) */
+        configTTL: number;
+        /** 结果缓存TTL(秒) */
+        resultTTL: number;
+    };
+}
+/** 导出服务基础异常 */
+declare class ExportServiceError extends Error {
+    readonly code: string;
+    readonly details?: Record<string, any> | undefined;
+    constructor(message: string, code: string, details?: Record<string, any> | undefined);
+}
+/** 导出配置错误 */
+declare class ExportConfigError extends ExportServiceError {
+    constructor(message: string, details?: Record<string, any>);
+}
+/** 导出数据处理错误 */
+declare class ExportDataError extends ExportServiceError {
+    constructor(message: string, details?: Record<string, any>);
+}
+/** 导出文件生成错误 */
+declare class ExportFileError extends ExportServiceError {
+    constructor(message: string, details?: Record<string, any>);
+}
+/** 导出事件类型 */
+type ExportEventType = 'export:start' | 'export:progress' | 'export:complete' | 'export:error' | 'export:cancel' | 'config:save' | 'config:delete';
+/** 导出事件 */
+interface ExportEvent {
+    /** 事件类型 */
+    type: ExportEventType;
+    /** 导出ID */
+    exportId: string;
+    /** 事件时间 */
+    timestamp: Date;
+    /** 事件数据 */
+    data?: Record<string, any>;
+    /** 错误信息 */
+    error?: string;
+}
+/** 导出事件监听器 */
+type ExportEventListener = (event: ExportEvent) => void | Promise<void>;
+/** 字段映射函数 */
+type FieldMapper<T = any> = (item: T, index: number) => Record<string, any>;
+/** 数据转换函数 */
+type DataTransformer<T = any, R = any> = (data: T[]) => R[];
+/** 验证函数 */
+type Validator<T = any> = (data: T) => boolean | string;
+/** 格式化函数 */
+type Formatter<T = any> = (value: T) => string;
+
+/**
+ * 通用导出服务工具函数
+ */
+
+/**
+ * 生成导出文件名
+ */
+declare function generateExportFileName(template: string, format: ExportFormat): string;
+/**
+ * 验证文件名是否合法
+ */
+declare function validateFileName(fileName: string): boolean;
+/**
+ * 清理文件名，移除非法字符
+ */
+declare function sanitizeFileName(fileName: string): string;
+/**
+ * 转义CSV字段
+ */
+declare function escapeCSVField(value: string, delimiter?: string): string;
+/**
+ * 解析CSV字段
+ */
+declare function parseCSVField(field: string): string;
+/**
+ * 内置格式化器集合
+ */
+declare const DEFAULT_FORMATTERS: Record<string, Formatter>;
+/**
+ * 应用格式化器
+ */
+declare function applyFormatter(value: any, formatter?: Formatter, type?: string): string;
+/**
+ * 验证导出配置
+ */
+declare function validateExportConfig(config: any): {
+    valid: boolean;
+    errors: string[];
+};
+/**
+ * 验证导出请求
+ */
+declare function validateExportRequest(request: any): {
+    valid: boolean;
+    errors: string[];
+};
+/**
+ * 格式化文件大小
+ */
+declare function formatFileSize(bytes: number): string;
+/**
+ * 格式化持续时间
+ */
+declare function formatDuration(milliseconds: number): string;
+/**
+ * 计算预计完成时间
+ */
+declare function estimateEndTime(startTime: Date, processedRows: number, totalRows: number): Date | undefined;
+/**
+ * 获取嵌套对象的值
+ */
+declare function getNestedValue(obj: any, path: string): any;
+/**
+ * 设置嵌套对象的值
+ */
+declare function setNestedValue(obj: any, path: string, value: any): void;
+/**
+ * 创建导出错误对象
+ */
+declare function createExportError(code: string, message: string, details?: Record<string, any>): {
+    code: string;
+    message: string;
+    details?: Record<string, any>;
+    timestamp: Date;
+};
+/**
+ * 格式化错误消息
+ */
+declare function formatErrorMessage(error: unknown): string;
+
+export { estimateEndTime as A, formatDuration as B, formatErrorMessage as C, DEFAULT_FORMATTERS as D, type ExportConfig as E, type FieldAlignment as F, type GroupValueProcessing as G, formatFileSize as H, generateExportFileName as I, getNestedValue as J, parseCSVField as K, sanitizeFileName as L, setNestedValue as M, validateExportConfig as N, validateExportRequest as O, validateFileName as P, type UniversalExportServiceConfig as U, type Validator as V, type DataTransformer as a, ExportConfigError as b, ExportDataError as c, type ExportError as d, type ExportEvent as e, type ExportEventListener as f, type ExportEventType as g, type ExportField as h, ExportFileError as i, type ExportFilter as j, type ExportFormat as k, type ExportProgress as l, type ExportRequest as m, type ExportResult as n, ExportServiceError as o, type ExportSort as p, type ExportStatus as q, type FieldMapper as r, type FieldType as s, type Formatter as t, type GroupingConfig as u, type GroupingField as v, type GroupingMode as w, applyFormatter as x, createExportError as y, escapeCSVField as z };