@bit-sun/business-component 4.2.0-alpha.27 → 4.2.0-alpha.29

package/.fatherrc.ts

@@ -1,5 +1,5 @@
 export default {
   esm: 'rollup',
   cjs: 'rollup',
-  extraExternals: ['@ant-design/pro-layout', '@babel/parser'],
+  extraExternals: ['@ant-design/pro-layout', '@babel/parser', 'umi'],
 };

package/dist/components/Business/ImportExport/ExportButton/ModalTitle.d.ts

@@ -0,0 +1,11 @@
+import React from 'react';
+interface ModalTitleProps {
+    icon: React.ReactNode;
+    title: React.ReactNode;
+    description: React.ReactNode;
+}
+/**
+ * 统一导出弹窗标题区的图标、主标题和辅助说明。
+ */
+declare const ModalTitle: React.FC<ModalTitleProps>;
+export default ModalTitle;

package/dist/components/Business/ImportExport/ExportButton/TemplatePicker.d.ts

@@ -0,0 +1,13 @@
+import React from 'react';
+import type { ImportExportRequestContext, ImportExportServices } from '../types';
+interface TemplatePickerProps {
+    visible: boolean;
+    context: ImportExportRequestContext;
+    services: ImportExportServices;
+    onCancel: () => void;
+    onConfirm: (templateCode: string, fileType: string) => Promise<void>;
+    documentName?: string;
+    resultCount?: number;
+}
+declare const TemplatePicker: React.FC<TemplatePickerProps>;
+export default TemplatePicker;

package/dist/components/Business/ImportExport/ExportButton/index.d.ts

@@ -0,0 +1,15 @@
+import React from 'react';
+import type { FileTask, ImportExportConfig, ImportExportRequestContext, ImportExportServices } from '../types';
+export interface ExportButtonProps {
+    config: ImportExportConfig;
+    services: ImportExportServices;
+    resolveRequestContext: () => Promise<ImportExportRequestContext | undefined>;
+    showQuickExport: boolean;
+    showTemplateExport: boolean;
+    onTaskCreated: (task: FileTask) => void;
+}
+/**
+ * 提供快速导出和按模板导出入口。
+ */
+declare const ExportButton: React.FC<ExportButtonProps>;
+export default ExportButton;

package/dist/components/Business/ImportExport/ImportWizard/Preview.d.ts

@@ -0,0 +1,11 @@
+import React from 'react';
+interface PreviewProps {
+    preview: any;
+    onBack: () => void;
+    onExecute: () => void;
+    onDownloadErrorFile: () => void;
+    executing: boolean;
+    downloadingErrorFile: boolean;
+}
+declare const Preview: React.FC<PreviewProps>;
+export default Preview;

package/dist/components/Business/ImportExport/ImportWizard/index.d.ts

@@ -0,0 +1,15 @@
+import React from 'react';
+import type { FileTask, ImportExportRequestContext, ImportExportServices } from '../types';
+export interface ImportWizardProps {
+    visible: boolean;
+    context: ImportExportRequestContext;
+    documentName?: string;
+    services: ImportExportServices;
+    onClose: () => void;
+    onTaskCreated?: (task: FileTask) => void;
+}
+/**
+ * 完成模板选择、文件上传、数据校验和正式导入的两步向导。
+ */
+declare const ImportWizard: React.FC<ImportWizardProps>;
+export default ImportWizard;

package/dist/components/Business/ImportExport/TaskDrawer/index.d.ts

@@ -0,0 +1,15 @@
+import React from 'react';
+import type { ImportExportServices } from '../types';
+export interface TaskDrawerProps {
+    /** 最近任务对应的业务功能编码集合。 */
+    businessFunctionCodes: string[];
+    services: ImportExportServices;
+    /** 任务中心路由。 */
+    taskCenterPath?: string;
+    onNavigateTaskCenter?: (path: string) => void;
+}
+/**
+ * 展示当前业务功能最近的文件任务。
+ */
+declare const TaskDrawer: React.FC<TaskDrawerProps>;
+export default TaskDrawer;

package/dist/components/Business/ImportExport/TaskProgress/index.d.ts

@@ -0,0 +1,15 @@
+import React from 'react';
+import type { FileTask, ImportExportServices } from '../types';
+export interface TaskProgressProps {
+    tasks: FileTask[];
+    services: ImportExportServices;
+    taskCenterPath?: string;
+    onNavigateTaskCenter?: (path: string) => void;
+    onTaskUpdated: (task: FileTask) => void;
+    onClose: () => void;
+}
+/**
+ * 轮询并展示当前页面创建的文件任务进度。
+ */
+declare const TaskProgress: React.FC<TaskProgressProps>;
+export default TaskProgress;

package/dist/components/Business/ImportExport/businessFunction.d.ts

@@ -0,0 +1,15 @@
+import type { ImportExportOperationType } from './types';
+/**
+ * 导入导出按钮权限编码集合。
+ */
+export interface ImportExportAuthCodes {
+    importCode: string;
+    quickExportCode: string;
+    templateExportCode: string;
+}
+/**
+ * 根据操作类型和按钮权限编码解析关联的业务功能编码。
+ *
+ * 导入使用独立入口；快速导出和模板导出共用任一已配置的导出入口。
+ */
+export declare const resolveBusinessFunctionCode: (operationType: ImportExportOperationType, authCodes: ImportExportAuthCodes) => string;

package/dist/components/Business/ImportExport/index.d.ts

@@ -0,0 +1,14 @@
+import React from 'react';
+import type { ImportExportActionsProps } from './types';
+/**
+ * 统一承载导入、快速导出、模板导出和文件任务入口。
+ */
+export declare const ImportExportActions: React.FC<ImportExportActionsProps>;
+export { default as ImportWizard } from './ImportWizard';
+export { default as ExportButton } from './ExportButton';
+export { default as TaskProgress } from './TaskProgress';
+export { default as TaskDrawer } from './TaskDrawer';
+export * from './types';
+export * from './services/importExport';
+export * from './sceneCapability';
+export * from './businessFunction';

package/dist/components/Business/ImportExport/sceneCapability.d.ts

@@ -0,0 +1,20 @@
+/**
+ * 导入导出场景能力开关。
+ */
+export interface SceneCapabilityConfig {
+    multiSheet?: boolean;
+    horizontalExport?: boolean;
+    largeFile?: boolean;
+}
+/**
+ * 判断是否启用多工作表能力。
+ */
+export declare const isMultiSheetEnabled: (config?: SceneCapabilityConfig) => boolean;
+/**
+ * 判断是否启用横向导出能力。
+ */
+export declare const isHorizontalExportEnabled: (config?: SceneCapabilityConfig) => boolean;
+/**
+ * 判断是否启用大文件导出能力。
+ */
+export declare const isLargeFileExportEnabled: (config?: SceneCapabilityConfig) => boolean;

package/dist/components/Business/ImportExport/services/importExport.d.ts

@@ -0,0 +1,22 @@
+import type { ImportExportRequest, ImportExportServices } from '../types';
+export { buildSdkUrl, normalizeServiceContext } from './routing';
+export declare const concurrentLimitCode = "IE-COM-CONCURRENT-FILE-LIMIT";
+/**
+ * 使用业务项目提供的请求函数创建完整导入导出服务。
+ *
+ * 请求函数由消费方注入，以复用其鉴权、租户和异常处理拦截器。
+ */
+export declare const createImportExportServices: (request: ImportExportRequest, overrides?: Partial<ImportExportServices>) => ImportExportServices;
+/**
+ * 使用宿主项目的 Umi 请求实例创建默认导入导出服务。
+ */
+export declare const defaultImportExportServices: ImportExportServices;
+/**
+ * 将业务侧差异服务合并到默认导入导出服务。
+ */
+export declare const resolveImportExportServices: (overrides?: Partial<ImportExportServices>) => ImportExportServices;
+export declare const unwrapResponse: <T = any>(response: any) => T;
+export declare const getItems: <T = any>(response: any) => T[];
+export declare const normalizeTask: (task: any) => any;
+export declare const taskTypeName: (taskType?: string) => string;
+export declare const isConcurrentLimit: (response: any) => boolean;

package/dist/components/Business/ImportExport/services/routing.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 校验并规范化业务功能服务上下文。
+ */
+export declare const normalizeServiceContext: (serviceContext: string) => string;
+/**
+ * 拼接导入导出 SDK 接口地址。
+ */
+export declare const buildSdkUrl: (serviceContext: string, path: string) => string;

package/dist/components/Business/ImportExport/types.d.ts

@@ -0,0 +1,134 @@
+/**
+ * 导入导出的操作类型。
+ */
+export type ImportExportOperationType = 'IMPORT' | 'EXPORT';
+/**
+ * 导入导出功能的业务侧配置。
+ */
+export interface ImportExportConfig {
+    documentName: string;
+    getQueryParams?: () => Record<string, any>;
+    getResultCount?: () => number | undefined;
+}
+/**
+ * 业务功能解析结果。
+ */
+export interface ImportExportBusinessFunction {
+    functionCode: string;
+    functionName?: string;
+    serviceName: string;
+    serviceContext: string;
+    status: number;
+}
+/**
+ * 一次导入或导出操作所需的请求上下文。
+ */
+export interface ImportExportRequestContext {
+    businessFunctionCode: string;
+    serviceContext: string;
+    operationType: ImportExportOperationType;
+    conditions?: Record<string, any>;
+}
+/**
+ * 导入导出模板摘要。
+ */
+export interface ImportExportTemplate {
+    templateCode: string;
+    templateName: string;
+    visibility?: 'PUBLIC' | 'PERSONAL';
+    businessFunctionCode?: string;
+    defaultFlag?: boolean;
+    enabled?: boolean;
+    metadataEntityCode?: string;
+    fieldCount?: number;
+    fieldNames?: string[];
+}
+/**
+ * 模板字段定义。
+ */
+export interface ImportExportTemplateField {
+    fieldCode: string;
+    displayName?: string;
+    mapped?: boolean;
+    required?: boolean;
+    groupKey?: boolean;
+    fieldStatus?: string;
+}
+/**
+ * 导入导出异步任务。
+ */
+export interface FileTask {
+    taskId: string;
+    taskType: string;
+    templateName?: string;
+    taskStatus: string;
+    progress?: number;
+    processedCount?: number;
+    totalCount?: number;
+    elapsedSeconds?: number;
+    successCount?: number;
+    failedCount?: number;
+    skippedCount?: number;
+    operatorName?: string;
+    fileName?: string;
+    createdTime?: string;
+    resultDownloadUrl?: string;
+    errorDownloadUrl?: string;
+    errorMessage?: string;
+    serviceContext?: string;
+}
+/**
+ * 业务项目请求函数需要支持的最小请求参数。
+ */
+export interface ImportExportRequestOptions {
+    method: 'GET' | 'POST';
+    data?: any;
+    params?: Record<string, any>;
+    responseType?: 'json' | 'text' | 'blob' | 'arrayBuffer' | 'formData';
+}
+/**
+ * 由业务项目注入的请求函数。
+ */
+export type ImportExportRequest = (url: string, options: ImportExportRequestOptions) => Promise<any>;
+/**
+ * 导入导出流程依赖的后端服务集合。
+ */
+export interface ImportExportServices {
+    resolveBusinessFunction: (businessFunctionCode: string) => Promise<any>;
+    queryTemplates: (data: Record<string, any>) => Promise<any>;
+    queryTemplateFields: (data: Record<string, any>) => Promise<any>;
+    uploadFile: (file: File) => Promise<any>;
+    downloadTemplate: (templateCode: string, data: Record<string, any>) => Promise<any>;
+    previewImport: (serviceContext: string, data: Record<string, any>) => Promise<any>;
+    executeImport: (serviceContext: string, data: Record<string, any>) => Promise<any>;
+    downloadValidationErrorFile: (serviceContext: string, data: Record<string, any>) => Promise<any>;
+    quickExport: (serviceContext: string, data: Record<string, any>) => Promise<any>;
+    templateExport: (serviceContext: string, data: Record<string, any>) => Promise<any>;
+    queryRecentTasks: (data: Record<string, any>) => Promise<any>;
+    queryTask: (serviceContext: string, taskCode: string) => Promise<any>;
+}
+/**
+ * 导入导出操作区属性。
+ */
+export interface ImportExportActionsProps {
+    /** 导入导出业务配置。 */
+    config: ImportExportConfig;
+    /** 导入导出服务集合。 */
+    services?: Partial<ImportExportServices>;
+    /** 导入按钮权限编码。 */
+    importCode: string;
+    /** 快速导出按钮权限编码。 */
+    quickExportCode: string;
+    /** 模板导出按钮权限编码。 */
+    templateExportCode: string;
+    /** 任务中心路由。 */
+    taskCenterPath?: string;
+    /** 是否显示最近任务入口。 */
+    showTaskDrawer?: boolean;
+    /** 跳转任务中心的业务侧回调。 */
+    onNavigateTaskCenter?: (path: string) => void;
+}
+/**
+ * 根据业务配置和后端服务上下文生成一次导入或导出请求上下文。
+ */
+export declare const createRequestContext: (config: ImportExportConfig, businessFunctionCode: string, serviceContext: string, operationType: ImportExportOperationType) => ImportExportRequestContext;

package/dist/index.d.ts

@@ -40,3 +40,4 @@ export { default as ExtendedCollapse } from './components/Common/ExtendedCollaps
 export { default as Section } from './components/Common/Section';
 export { default as ParagraphCopier } from './components/Common/ParagraphCopier';
 export { default as SystemLog } from './components/Business/SystemLog';
+export * from './components/Business/ImportExport';