@nokecy/qc-ui 1.0.59 → 1.0.61

package/dist/cjs/generatedListPage/index.js

@@ -0,0 +1,92 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "AccessWrapper", {
+  enumerable: true,
+  get: function get() {
+    return _AccessWrapper.default;
+  }
+});
+Object.defineProperty(exports, "ConfigurableToolbar", {
+  enumerable: true,
+  get: function get() {
+    return _ConfigurableToolbar.default;
+  }
+});
+Object.defineProperty(exports, "GeneratedListPage", {
+  enumerable: true,
+  get: function get() {
+    return _GeneratedListPage.default;
+  }
+});
+Object.defineProperty(exports, "OptionsColumn", {
+  enumerable: true,
+  get: function get() {
+    return _OptionsColumn.default;
+  }
+});
+Object.defineProperty(exports, "PerformanceDevTools", {
+  enumerable: true,
+  get: function get() {
+    return _PerformanceMonitor.PerformanceDevTools;
+  }
+});
+Object.defineProperty(exports, "PermissionChecker", {
+  enumerable: true,
+  get: function get() {
+    return _usePermissionCheck.PermissionChecker;
+  }
+});
+Object.defineProperty(exports, "default", {
+  enumerable: true,
+  get: function get() {
+    return _GeneratedListPage.default;
+  }
+});
+Object.defineProperty(exports, "defaultHandleDelete", {
+  enumerable: true,
+  get: function get() {
+    return _defaultHandlers.defaultHandleDelete;
+  }
+});
+Object.defineProperty(exports, "defaultHandleExport", {
+  enumerable: true,
+  get: function get() {
+    return _defaultHandlers.defaultHandleExport;
+  }
+});
+Object.defineProperty(exports, "downloadFile", {
+  enumerable: true,
+  get: function get() {
+    return _defaultHandlers.downloadFile;
+  }
+});
+Object.defineProperty(exports, "usePerformanceMonitor", {
+  enumerable: true,
+  get: function get() {
+    return _PerformanceMonitor.usePerformanceMonitor;
+  }
+});
+Object.defineProperty(exports, "usePermissionCheck", {
+  enumerable: true,
+  get: function get() {
+    return _usePermissionCheck.usePermissionCheck;
+  }
+});
+Object.defineProperty(exports, "useRequestManager", {
+  enumerable: true,
+  get: function get() {
+    return _useRequestManager.useRequestManager;
+  }
+});
+var _GeneratedListPage = _interopRequireDefault(require("./GeneratedListPage"));
+var _ConfigurableToolbar = _interopRequireDefault(require("./ConfigurableToolbar"));
+var _OptionsColumn = _interopRequireDefault(require("./OptionsColumn"));
+var _usePermissionCheck = require("./usePermissionCheck");
+var _PerformanceMonitor = require("./PerformanceMonitor");
+var _useRequestManager = require("./useRequestManager");
+var _AccessWrapper = _interopRequireDefault(require("./_utils/AccessWrapper"));
+var _defaultHandlers = require("./_utils/defaultHandlers");
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }

package/dist/cjs/generatedListPage/types.d.ts

@@ -0,0 +1,221 @@
+/// <reference types="react" />
+import { GridRef } from "../ag-grid-plus/interface";
+import { ColDef } from "ag-grid-community";
+import { ButtonProps } from "antd";
+/**
+ * 权限配置接口
+ */
+export interface PermissionConfig {
+    /** 查看权限 */
+    view?: string;
+    /** 创建权限 */
+    create?: string;
+    /** 更新权限 */
+    update?: string;
+    /** 删除权限 */
+    delete?: string;
+    /** 导入权限 */
+    import?: string;
+    /** 导出权限 */
+    export?: string;
+}
+/**
+ * 列表查询参数接口
+ */
+export interface ListParams {
+    /** 筛选条件 */
+    filter?: string;
+    /** 跳过数量 */
+    skipCount?: number;
+    /** 最大结果数 */
+    maxResultCount?: number;
+    /** 排序字段 */
+    sorting?: string;
+    /** 分页大小 */
+    PageSize?: number;
+    /** 跳过数量(兼容) */
+    SkipCount?: number;
+    /** 最大结果数(兼容) */
+    MaxResultCount?: number;
+    /** 排序(兼容) */
+    Sorting?: string;
+    /** 筛选(兼容) */
+    Filter?: string;
+}
+/**
+ * 分页结果接口
+ */
+export interface PagedResult<T> {
+    /** 数据项列表 */
+    items?: T[];
+    /** 总数量 */
+    totalCount?: number;
+}
+/**
+ * 删除参数接口
+ */
+export interface DeleteParams {
+    /** 记录ID */
+    id: string | number;
+}
+/**
+ * 导出参数接口
+ */
+export interface ExportParams {
+    /** 筛选条件 */
+    filter?: string;
+    /** 其他参数 */
+    [key: string]: any;
+}
+/**
+ * API配置接口
+ * @template T 数据项类型
+ */
+export interface ApiConfig<T = any> {
+    /** 列表查询API */
+    list: (params: ListParams) => Promise<PagedResult<T>>;
+    /** 删除API */
+    delete?: (params: DeleteParams) => Promise<void>;
+    /** 导出API */
+    export?: (params: ExportParams) => Promise<Blob>;
+    /** 获取导入模板API */
+    getImportTemplate?: () => Promise<Blob>;
+    /** 导入API */
+    import?: (file: FormData) => Promise<void>;
+}
+/**
+ * 工具栏按钮配置
+ */
+export interface ToolbarActionConfig {
+    /** 按钮类型 */
+    type: 'create' | 'import' | 'export' | 'downloadTemplate' | 'custom';
+    /** 权限键 */
+    permission?: string;
+    /** 按钮文本 */
+    label?: string;
+    /** 按钮属性 */
+    buttonProps?: ButtonProps;
+    /** 自定义组件（当type为custom时） */
+    component?: React.ComponentType<any>;
+    /** 组件属性 */
+    componentProps?: Record<string, any>;
+    /** 点击处理函数（当type为custom时） */
+    onClick?: () => void;
+}
+/**
+ * 表单对话框组件配置
+ */
+export interface FormDialogConfig {
+    /** 表单组件 */
+    component: React.ComponentType<any>;
+    /** 标题 */
+    title?: string;
+    /** 新建标题 */
+    createTitle?: string;
+    /** 编辑标题 */
+    editTitle?: string;
+}
+/**
+ * 树形数据配置
+ */
+export interface TreeDataConfig {
+    /** 是否为树形数据 */
+    enabled: boolean;
+    /** 获取数据路径的函数 */
+    getDataPath?: (data: any) => string[];
+    /** 父节点字段名 */
+    parentFieldName?: string;
+    /** 主键字段名 */
+    keyFieldName?: string;
+    /** 自动分组列配置 */
+    autoGroupColumnDef?: ColDef;
+    /** 默认展开层级 */
+    groupDefaultExpanded?: number;
+    /** 树形数据API - 已包含树形结构(items字段) */
+    treeApi?: () => Promise<any[]>;
+    /** 子节点字段名 */
+    childrenFieldName?: string;
+    /**
+     * 自动模式:从扁平数据构建树形结构
+     * 当设置为 true 时,将自动从 list API 的扁平数据构建树形结构
+     * 需要配合 parentFieldName 和 keyFieldName 使用
+     */
+    autoMode?: boolean;
+    /**
+     * 树形路径显示字段
+     * 用于构建树形路径时显示的字段名,默认使用 'name'
+     * 可以是单个字段名或字段名数组(按优先级尝试)
+     */
+    pathDisplayField?: string | string[];
+}
+/**
+ * 通用列表页面配置接口
+ * @template T 数据项类型
+ */
+export interface GeneratedListPageConfig<T = any> {
+    /** 页面标题 */
+    title: string;
+    /** Grid Key */
+    gridKey: string;
+    /** API配置 */
+    apiConfig: ApiConfig<T>;
+    /** 权限配置 */
+    permissions: PermissionConfig;
+    /** 列定义 */
+    columnDefs: ColDef[];
+    /** 表单对话框配置 */
+    formDialog?: FormDialogConfig;
+    /** 工具栏配置 */
+    toolbarActions?: ToolbarActionConfig[];
+    /** 是否启用导入导出模板下载 */
+    enableImportExport?: boolean;
+    /** 导入配置 */
+    importConfig?: {
+        /** 标题 */
+        title?: string;
+        /** 下载模板URL */
+        downUrl?: string;
+        /** 上传URL */
+        uploadUrl?: string;
+    };
+    /** 导出文件名 */
+    exportFileName?: string;
+    /** 树形数据配置 */
+    treeConfig?: TreeDataConfig;
+    /** 自定义操作列组件 */
+    customOptionsComponent?: React.ComponentType<OptionsComponentProps<T>>;
+    /** 错误处理配置 */
+    errorConfig?: {
+        /** 是否使用统一错误处理 */
+        useErrorHandler?: boolean;
+    };
+    /** 分页配置 */
+    paginationConfig?: {
+        /** 默认页大小 */
+        defaultPageSize?: number;
+        /** 是否启用分页 */
+        enabled?: boolean;
+    };
+    /** Grid引用 */
+    gridRef?: React.RefObject<GridRef>;
+    /** 刷新回调 */
+    onRefresh?: () => void;
+}
+/**
+ * 操作列组件属性接口
+ * @template T 行数据类型
+ */
+export interface OptionsComponentProps<T = any> {
+    /** 行数据 */
+    data: T;
+    /** 刷新函数 */
+    onRefresh: () => void;
+    /** 权限配置 */
+    permissions: PermissionConfig;
+    /** 表单对话框配置 */
+    formDialog?: FormDialogConfig;
+    /** 删除API */
+    deleteApi?: (params: DeleteParams) => Promise<void>;
+    /** 是否使用统一错误处理 */
+    useErrorHandler?: boolean;
+}

package/dist/cjs/generatedListPage/types.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/dist/cjs/generatedListPage/usePermissionCheck.d.ts

@@ -0,0 +1,66 @@
+/**
+ * usePermissionCheck Hook
+ *
+ * 提供统一的权限检查功能,避免重复的权限检查逻辑
+ * 适配版：支持外部传入 access 对象或使用默认的全部允许策略
+ */
+import { PermissionConfig } from './types';
+interface PermissionCheckResult {
+    /** 是否有查看权限 */
+    canView: boolean;
+    /** 是否有创建权限 */
+    canCreate: boolean;
+    /** 是否有更新权限 */
+    canUpdate: boolean;
+    /** 是否有删除权限 */
+    canDelete: boolean;
+    /** 是否有导入权限 */
+    canImport: boolean;
+    /** 是否有导出权限 */
+    canExport: boolean;
+    /** 检查特定权限 */
+    hasPermission: (permission?: string) => boolean;
+    /** 检查多个权限(需要全部满足) */
+    hasAllPermissions: (...permissions: (string | undefined)[]) => boolean;
+    /** 检查多个权限(满足任一即可) */
+    hasAnyPermission: (...permissions: (string | undefined)[]) => boolean;
+}
+/**
+ * 权限检查 Hook
+ * @param permissions 权限配置对象
+ * @param access 可选的 access 对象（如果不传入，默认全部允许）
+ * @returns 权限检查结果
+ */
+export declare function usePermissionCheck(permissions: PermissionConfig, access?: Record<string, boolean>): PermissionCheckResult;
+/**
+ * 权限检查工具类
+ * 用于非 Hook 场景下的权限检查
+ */
+export declare class PermissionChecker {
+    private access;
+    constructor(access: Record<string, boolean>);
+    /**
+     * 检查单个权限
+     */
+    hasPermission(permission?: string): boolean;
+    /**
+     * 检查多个权限(需要全部满足)
+     */
+    hasAllPermissions(...permissions: (string | undefined)[]): boolean;
+    /**
+     * 检查多个权限(满足任一即可)
+     */
+    hasAnyPermission(...permissions: (string | undefined)[]): boolean;
+    /**
+     * 检查权限配置对象
+     */
+    checkConfig(config: PermissionConfig): {
+        canView: boolean;
+        canCreate: boolean;
+        canUpdate: boolean;
+        canDelete: boolean;
+        canImport: boolean;
+        canExport: boolean;
+    };
+}
+export default usePermissionCheck;

package/dist/cjs/generatedListPage/usePermissionCheck.js

@@ -0,0 +1,150 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = exports.PermissionChecker = void 0;
+exports.usePermissionCheck = usePermissionCheck;
+var _react = require("react");
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, _toPropertyKey(descriptor.key), descriptor); } }
+function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : String(i); }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /**
+ * usePermissionCheck Hook
+ *
+ * 提供统一的权限检查功能,避免重复的权限检查逻辑
+ * 适配版：支持外部传入 access 对象或使用默认的全部允许策略
+ */
+/**
+ * 权限检查 Hook
+ * @param permissions 权限配置对象
+ * @param access 可选的 access 对象（如果不传入，默认全部允许）
+ * @returns 权限检查结果
+ */
+function usePermissionCheck(permissions, access) {
+  // 缓存权限检查结果
+  var permissionResult = (0, _react.useMemo)(function () {
+    /**
+     * 检查单个权限
+     */
+    var hasPermission = function hasPermission(permission) {
+      if (!permission) return true; // 未配置权限则默认有权限
+      if (!access) return true; // 未传入 access 对象,默认全部允许
+      return !!access[permission];
+    };
+
+    /**
+     * 检查多个权限(需要全部满足)
+     */
+    var hasAllPermissions = function hasAllPermissions() {
+      for (var _len = arguments.length, perms = new Array(_len), _key = 0; _key < _len; _key++) {
+        perms[_key] = arguments[_key];
+      }
+      if (perms.length === 0) return true;
+      return perms.every(function (perm) {
+        return hasPermission(perm);
+      });
+    };
+
+    /**
+     * 检查多个权限(满足任一即可)
+     */
+    var hasAnyPermission = function hasAnyPermission() {
+      for (var _len2 = arguments.length, perms = new Array(_len2), _key2 = 0; _key2 < _len2; _key2++) {
+        perms[_key2] = arguments[_key2];
+      }
+      if (perms.length === 0) return true;
+      return perms.some(function (perm) {
+        return hasPermission(perm);
+      });
+    };
+    return {
+      canView: hasPermission(permissions.view),
+      canCreate: hasPermission(permissions.create),
+      canUpdate: hasPermission(permissions.update),
+      canDelete: hasPermission(permissions.delete),
+      canImport: hasPermission(permissions.import),
+      canExport: hasPermission(permissions.export),
+      hasPermission: hasPermission,
+      hasAllPermissions: hasAllPermissions,
+      hasAnyPermission: hasAnyPermission
+    };
+  }, [access, permissions]);
+  return permissionResult;
+}
+
+/**
+ * 权限检查工具类
+ * 用于非 Hook 场景下的权限检查
+ */
+var PermissionChecker = exports.PermissionChecker = /*#__PURE__*/function () {
+  function PermissionChecker(access) {
+    _classCallCheck(this, PermissionChecker);
+    _defineProperty(this, "access", void 0);
+    this.access = access;
+  }
+
+  /**
+   * 检查单个权限
+   */
+  _createClass(PermissionChecker, [{
+    key: "hasPermission",
+    value: function hasPermission(permission) {
+      if (!permission) return true;
+      return !!this.access[permission];
+    }
+
+    /**
+     * 检查多个权限(需要全部满足)
+     */
+  }, {
+    key: "hasAllPermissions",
+    value: function hasAllPermissions() {
+      var _this = this;
+      for (var _len3 = arguments.length, permissions = new Array(_len3), _key3 = 0; _key3 < _len3; _key3++) {
+        permissions[_key3] = arguments[_key3];
+      }
+      if (permissions.length === 0) return true;
+      return permissions.every(function (perm) {
+        return _this.hasPermission(perm);
+      });
+    }
+
+    /**
+     * 检查多个权限(满足任一即可)
+     */
+  }, {
+    key: "hasAnyPermission",
+    value: function hasAnyPermission() {
+      var _this2 = this;
+      for (var _len4 = arguments.length, permissions = new Array(_len4), _key4 = 0; _key4 < _len4; _key4++) {
+        permissions[_key4] = arguments[_key4];
+      }
+      if (permissions.length === 0) return true;
+      return permissions.some(function (perm) {
+        return _this2.hasPermission(perm);
+      });
+    }
+
+    /**
+     * 检查权限配置对象
+     */
+  }, {
+    key: "checkConfig",
+    value: function checkConfig(config) {
+      return {
+        canView: this.hasPermission(config.view),
+        canCreate: this.hasPermission(config.create),
+        canUpdate: this.hasPermission(config.update),
+        canDelete: this.hasPermission(config.delete),
+        canImport: this.hasPermission(config.import),
+        canExport: this.hasPermission(config.export)
+      };
+    }
+  }]);
+  return PermissionChecker;
+}();
+var _default = exports.default = usePermissionCheck;

package/dist/cjs/generatedListPage/useRequestManager.d.ts

@@ -0,0 +1,35 @@
+/**
+ * useRequestManager Hook
+ *
+ * 为组件提供请求管理功能的 React Hook
+ */
+interface UseRequestManagerOptions {
+    /** 防抖延迟时间(ms) */
+    debounceDelay?: number;
+    /** 是否启用缓存 */
+    enableCache?: boolean;
+    /** 缓存有效期(ms) */
+    cacheTTL?: number;
+    /** 是否启用请求去重 */
+    enableDedup?: boolean;
+    /** 最大并发数 */
+    maxConcurrent?: number;
+}
+/**
+ * 使用请求管理器的 Hook
+ */
+export declare function useRequestManager<T = any>(options?: UseRequestManagerOptions): {
+    request: (params: any, requestFn: (params: any, signal: AbortSignal) => Promise<T>) => Promise<T>;
+    debouncedRequest: (key: string, params: any, requestFn: (params: any, signal: AbortSignal) => Promise<T>) => Promise<T>;
+    cancelRequest: (params: any) => void;
+    cancelAllRequests: () => void;
+    clearCache: () => void;
+    cleanupCache: () => void;
+    getStats: () => {
+        cacheSize: number;
+        pendingRequests: number;
+        activeRequests: number;
+        queueSize: number;
+    };
+};
+export default useRequestManager;