@_tc/template-core 0.0.1-bate.37 → 0.0.1-bate.39

package/fe/packages/ui/react/lib/export.js

@@ -1,3 +1,24 @@
+/**
+ * 导出 Excel 工具方法
+ *
+ * 功能：
+ * - 支持导出「当前页」或「当前查询条件下的全部页数据」
+ * - 通过 DataTable 的 columns 控制导出列及顺序
+ *
+ * 使用方式（示例）：
+ * ```ts
+ * await exportToExcel({
+ *   fetchData: (pageNum, pageSize) => getWithdrawList({ ...searchParams, pageNum, pageSize }),
+ *   columns, // 直接复用 DataTable 的 columns
+ *   exportType: 'all', // 'all' 导出全部页；'current' 仅导出当前页
+ *   currentPage,
+ *   pageSize,
+ *   total,
+ *   currentPageData: tableData, // 可选，导出当前页时直接使用现有数据，避免重复请求
+ *   fileName: '提币记录',
+ * })
+ * ```
+ */
 import { message } from '../components';
 import * as XLSX from 'xlsx';
 const getTextFromReactNode = (node) => {
@@ -14,20 +35,31 @@ const getTextFromReactNode = (node) => {
     return String(node);
 };
 export const ExportType = {
+    /**
+     * 当前查询条件下所有页
+     */
     all: 0,
+    /**
+     * 当前页
+     */
     current: 1,
 };
+/** 读取嵌套字段值，支持 a.b.c 形式 */
 const getValue = (row, dataIndex) => {
     const key = String(dataIndex);
     if (!key.includes('.'))
         return row?.[key];
     return key.split('.').reduce((acc, cur) => (acc == null ? acc : acc[cur]), row);
 };
+/**
+ * 通用导出 Excel 方法
+ */
 export async function exportToExcel(options) {
     const { fetchData, exportType, currentPage = 1, pageSize = 2000, maxCount = 10000, currentPageData, fileName, } = options;
     const defaultSearchParams = { export: true };
     const cols = options.columns;
     const fieldConfigs = cols
+        // 过滤掉操作列
         .filter((col) => !col.isAction && col.key !== 'action')
         .map((col) => ({
         title: col.title,
@@ -42,6 +74,7 @@ export async function exportToExcel(options) {
     try {
         let allData = [];
         if (exportType === ExportType.current) {
+            // 优先使用已存在的当前页数据，避免重复请求
             if (currentPageData && currentPageData.length) {
                 allData = currentPageData;
             }
@@ -51,6 +84,7 @@ export async function exportToExcel(options) {
             }
         }
         else {
+            // 导出所有页：按页拉取，直到数据不足一整页或达到最大条数
             const list = [];
             for (let page = 1;; page += 1) {
                 const res = await fetchData(page, pageSize, defaultSearchParams);
@@ -58,10 +92,12 @@ export async function exportToExcel(options) {
                 if (!records.length)
                     break;
                 list.push(...records);
+                // 达到最大条数后直接截断并停止
                 if (list.length >= maxCount) {
                     list.length = maxCount;
                     break;
                 }
+                // 本页数据不足 pageSize，说明已到最后一页
                 if (records.length < pageSize)
                     break;
             }
@@ -72,9 +108,13 @@ export async function exportToExcel(options) {
             message.close(infoMessageId);
             return;
         }
+        // 构建表头
         const header = fieldConfigs.map((f) => f.title);
+        // 构建数据行
         const dataRows = allData.map((row, index) => fieldConfigs.map((f) => {
             const v = f.render ? f.render(getValue(row, f.dataIndex), row, index) : getValue(row, f.dataIndex);
+            // 如果v是ReactNode
+            // 需要获取最深层的text
             if (v && typeof v === 'object' && 'props' in v && 'children' in v.props) {
                 return getTextFromReactNode(v);
             }

package/fe/packages/ui/react/lib/utils.d.ts

@@ -1,8 +1,32 @@
 import { type ClassValue } from "clsx";
 export declare function cn(...inputs: ClassValue[]): string;
+/**
+ * 日期时间格式化工具
+ */
+/**
+ * 格式化日期时间
+ * @param date 日期字符串或 Date 对象
+ * @param format 格式化模板，默认 'YYYY-MM-DD HH:mm:ss'
+ * @returns 格式化后的字符串
+ */
 export declare function formatDateTime(date: string | Date | null | undefined | number, format?: string): string;
+/**
+ * 格式化日期
+ * @param date 日期字符串或 Date 对象
+ * @returns 格式化后的字符串 YYYY-MM-DD
+ */
 export declare function formatDate(date: string | Date | null | undefined): string;
+/**
+ * 格式化时间
+ * @param date 日期字符串或 Date 对象
+ * @returns 格式化后的字符串 HH:mm:ss
+ */
 export declare function formatTime(date: string | Date | null | undefined): string;
+/**
+ * 生成开始结束时间
+ * @param dates 日期字符串或 Date 对象数组
+ * @returns 开始结束时间对象 { start: string; end: string }
+ */
 export declare function generateStartEndTime(dates: string[] | Date[] | null | undefined): {
     start: string;
     end: string;

package/fe/packages/ui/react/lib/utils.js

@@ -3,10 +3,20 @@ import { twMerge } from "tailwind-merge";
 export function cn(...inputs) {
     return twMerge(clsx(inputs));
 }
+/**
+ * 日期时间格式化工具
+ */
+/**
+ * 格式化日期时间
+ * @param date 日期字符串或 Date 对象
+ * @param format 格式化模板，默认 'YYYY-MM-DD HH:mm:ss'
+ * @returns 格式化后的字符串
+ */
 export function formatDateTime(date, format = "YYYY-MM-DD HH:mm:ss") {
     if (!date)
         return "-";
     let d = new Date(date);
+    // 接口返回的时间戳为 秒
     const tmpY = d.getFullYear();
     if (typeof date === "number" && tmpY === 1970) {
         d = new Date(date * 1000);
@@ -27,12 +37,27 @@ export function formatDateTime(date, format = "YYYY-MM-DD HH:mm:ss") {
         .replace("mm", minutes)
         .replace("ss", seconds);
 }
+/**
+ * 格式化日期
+ * @param date 日期字符串或 Date 对象
+ * @returns 格式化后的字符串 YYYY-MM-DD
+ */
 export function formatDate(date) {
     return formatDateTime(date, "YYYY-MM-DD");
 }
+/**
+ * 格式化时间
+ * @param date 日期字符串或 Date 对象
+ * @returns 格式化后的字符串 HH:mm:ss
+ */
 export function formatTime(date) {
     return formatDateTime(date, "HH:mm:ss");
 }
+/**
+ * 生成开始结束时间
+ * @param dates 日期字符串或 Date 对象数组
+ * @returns 开始结束时间对象 { start: string; end: string }
+ */
 export function generateStartEndTime(dates) {
     if (!dates)
         return { start: "", end: "" };

package/fe/packages/ui/react/stores/breadcrumb.js

@@ -16,6 +16,7 @@ const loadBreadcrumbFromStorage = () => {
         }
     }
     catch {
+        // ignore
     }
     return [];
 };
@@ -24,6 +25,7 @@ const saveBreadcrumbToStorage = (items) => {
         localStorage.setItem(BREADCRUMB_STORAGE_KEY, JSON.stringify(items));
     }
     catch {
+        // ignore
     }
 };
 export const breadcrumbStore = create((set) => ({

package/model/index.d.ts

@@ -0,0 +1,2 @@
+export type { ModelDataType } from './types';
+//# sourceMappingURL=index.d.ts.map

package/model/types/data/button.d.ts

@@ -0,0 +1,32 @@
+import type { ButtonProps } from '../../../fe/packages/ui/react';
+import { ComponentNames } from './component';
+type ButtonTemplates = {
+    /**
+     * 按钮名
+     */
+    label?: string;
+} & ButtonProps;
+type ParamsValueData = 'schema::tableKey' | string | number;
+type RemoveBtn = {
+    eventKey: 'remove';
+    /**
+     * 事件配置 (参数配置)
+     */
+    eventOption: {
+        params: {
+            /**
+             *  @example user_id: 'schema::tableKey' | '123' | 123
+             */
+            [paramKey: string]: ParamsValueData;
+        };
+    };
+};
+type HandlerBtn = {
+    eventKey: 'callComponent';
+    eventOption: {
+        comName: ComponentNames;
+    };
+};
+export type BaseButton = ButtonTemplates & (RemoveBtn | HandlerBtn);
+export {};
+//# sourceMappingURL=button.d.ts.map

package/model/types/data/component.d.ts

@@ -0,0 +1,61 @@
+import { FormItemProps, InputNumberProps, InputProps, SelectProps } from '../../../fe/packages/ui/react';
+import { FetchInfo } from './fetchInfo';
+export type ComponentConfig = {
+    createForm?: {
+        /**
+         * 表单标题
+         */
+        title: string;
+        /**
+         *  保存按钮文案
+         */
+        saveBtnText?: string;
+    } & Pick<FetchInfo, 'fetchConfig'>;
+    editForm?: {
+        /**
+         * 表单标题
+         */
+        title: string;
+        /**
+         *  保存按钮文案
+         */
+        saveBtnText?: string;
+    } & FetchInfo;
+    detailPanel?: {
+        /**
+         * 表单标题
+         */
+        title: string;
+    } & FetchInfo;
+};
+export type ComponentNames = keyof ComponentConfig;
+export type ComponentsOption = {
+    createForm: FormItemProps & {
+        /**
+         * 是否展示 默认为true
+         */
+        visible?: boolean;
+        /**
+         * 是否禁用
+         */
+        disbaled?: boolean;
+        /**
+         * 默认值
+         */
+        default?: any;
+    } & ComponentOption;
+    editForm: ComponentsOption['createForm'];
+    detailPanel: {};
+};
+export type ComponentOption = InputOption | SelectOption | InputNumberOption;
+type InputOption = {
+    comType: 'input';
+} & InputProps;
+type InputNumberOption = {
+    comType: 'inputNumber';
+} & InputNumberProps;
+type SelectOption = {
+    comType: 'select';
+} & SelectProps;
+export {};
+//# sourceMappingURL=component.d.ts.map

package/model/types/data/fetchInfo.d.ts

@@ -0,0 +1,20 @@
+export type FetchInfo = {
+    /**
+     * 表单主键，  获取数据源的key
+     */
+    fetchKey: string;
+    /**
+     * 请求配置 如果不配置则使用 统一的 [get] api 内容
+     */
+    fetchConfig?: {
+        /**
+         * 获取数据的
+         */
+        url: string;
+        /**
+         * 请求方式
+         */
+        method?: 'get' | 'post';
+    };
+};
+//# sourceMappingURL=fetchInfo.d.ts.map

package/model/types/data/schema.d.ts

@@ -0,0 +1,98 @@
+import { TableColumnDef } from '../../../fe/packages/ui/react';
+import type { JSONSchema7 } from 'json-schema';
+import { MOmit } from '../../../fe/typings/type';
+import { BaseButton } from './button';
+import { ComponentConfig, ComponentNames, ComponentsOption } from './component';
+import { SearchOption } from './search';
+export type TableColumnsSchema = {
+    tableOption?: MOmit<TableColumnDef, 'key' | 'title'> & {
+        /**
+         * 是否显示
+         */
+        visible?: boolean;
+        /**
+         * 	保留几位小数
+         */
+        toFixed?: number;
+    };
+};
+export type TableSearchOption = {
+    /**
+     * 不配置则不在 search 中显示
+     */
+    searchOption?: {
+        /**
+         * 控件默认值
+         */
+        default?: any;
+    } & SearchOption;
+};
+export type TableConfig = {
+    /**
+     * table 头部按钮
+     */
+    headerButtons?: BaseButton[];
+    /**
+     * 每一行的按钮
+     */
+    rowButtons?: BaseButton[];
+};
+export type SearchConfig = {};
+export type BaseOption<O> = {
+    option: O;
+};
+export type UsedConfigSchema<T = {}> = {
+    type: 'object' | 'string' | 'array' | 'number' | 'boolean';
+    properties: {
+        /**
+         * [字段 key]: 字段描述
+         */
+        [key: string]: T & MOmit<UsedConfigSchema, 'properties'> & {
+            /**
+             * 展示 字符
+             */
+            label: string;
+            /**
+             *  原数据 序列化后 会丢失编写时的顺序
+             * 	字段层级  默认10
+             *
+             */
+            level?: number;
+        };
+    };
+    required?: string[];
+} & Omit<JSONSchema7, 'properties'>;
+export type TableComponentConfig = {
+    [K in ComponentNames as `${K & string}Option`]?: ComponentsOption[K];
+};
+export type ConfigSchema = UsedConfigSchema<TableColumnsSchema & TableSearchOption & TableComponentConfig>;
+export interface SchemaDataType {
+    /**
+     * 数据源地址  遵循 RESTFUL 规范
+     * *[参考地址](https://www.ruanyifeng.com/blog/2014/05/restful_api.html)*
+     *
+     * 即:
+     *
+     * - 获取数据 GET [api]
+     * - 新增数据 POST [api]
+     * - ...
+     */
+    api: string;
+    /**
+     * 板块数据结构
+     */
+    schema?: ConfigSchema;
+    /**
+     * 表格 (展示) 配置
+     */
+    tableConfig?: TableConfig;
+    /**
+     * 搜索 配置
+     */
+    searchConfig?: SearchConfig;
+    /**
+     * 模块组件
+     */
+    componentConfig?: ComponentConfig;
+}
+//# sourceMappingURL=schema.d.ts.map

package/model/types/data/search.d.ts

@@ -0,0 +1,7 @@
+import type { SchemaFormComponentPropsMap, SchemaFormFieldType } from '../../../fe/packages/ui/react';
+export type SearchOption = {
+    [K in SchemaFormFieldType]: {
+        comType: K;
+    } & SchemaFormComponentPropsMap[K];
+}[SchemaFormFieldType];
+//# sourceMappingURL=search.d.ts.map

package/model/types/index.d.ts

@@ -0,0 +1,2 @@
+export type { ModelDataType } from './model';
+//# sourceMappingURL=index.d.ts.map

package/model/types/menuType.d.ts

@@ -0,0 +1,73 @@
+import { SchemaDataType } from "./data/schema";
+/**
+ *  - parent menuLaout === 'top'
+ *    - child menuLayout === 'top' | 'left'
+ *  - parent menuLayout === 'left'
+ *    - child menuLayout === 'left'
+ */
+export type MenuLayout = "left" | "top";
+interface BaseMenu {
+    key: string;
+    icon?: string;
+    /**
+     * 菜单名称
+     */
+    name: string;
+}
+interface GroupMenuType<T extends MenuLayout> extends BaseMenu {
+    menuType: "group";
+    subMenu: T extends "top" ? TopMenuType[] : LeftMenuType[];
+}
+interface ModuleMenuType extends BaseMenu {
+    menuType: "module";
+}
+/**
+ *
+ * ----------------------------- moduletype -----------------------------
+ *
+ */
+interface IframeModuleType {
+    moduleType: "iframe";
+    iframeConfig: {
+        /**
+         * iframe 路径
+         */
+        path: string;
+    };
+}
+interface CustomModuleType {
+    moduleType: "custom";
+    customConfig: {
+        /**
+         * 自定义路由路径
+         */
+        path: string;
+    };
+}
+interface SchemaModuleType {
+    moduleType: "schema";
+    schemaConfig: SchemaDataType;
+}
+export interface SidebarModuleType {
+    moduleType: "sidebar";
+    sidebarConfig: {
+        menu: BaseMenuType[];
+        /**
+         * 只能为left
+         */
+        menuLayout?: "left";
+    };
+}
+export type BasicModuleType = SchemaModuleType | CustomModuleType | IframeModuleType;
+export type BaseMenuType = GroupMenuType<"left"> | (ModuleMenuType & BasicModuleType);
+type ModuleType = BasicModuleType | SidebarModuleType;
+/**
+ * top 包含所有
+ */
+export type TopMenuType = GroupMenuType<"top"> | (ModuleMenuType & ModuleType);
+/**
+ * left 不包含 sidebar
+ */
+export type LeftMenuType = GroupMenuType<"left"> | BaseMenuType;
+export {};
+//# sourceMappingURL=menuType.d.ts.map

package/model/types/model.d.ts

@@ -0,0 +1,33 @@
+import { TopMenuType, LeftMenuType } from "./menuType";
+type MTopMenuType = {
+    /**
+     * 默认为 left
+     */
+    menuLayout: "top";
+    menu: TopMenuType[];
+};
+type MLeftMenuType = {
+    /**
+     * 默认为 left
+     */
+    menuLayout?: "left";
+    menu: LeftMenuType[];
+};
+export type ModeMenuType = MTopMenuType | MLeftMenuType;
+export type ModelDataType = {
+    /**
+     * - 使用哪一块的模型数据 内置 MB
+     * 	- MB = 管理后台
+     */
+    mode: "MB";
+    key?: string;
+    name: string;
+    desc: string;
+    icon: string;
+    /**
+     * 首页(项目配置)
+     */
+    homePage: string;
+} & ModeMenuType;
+export {};
+//# sourceMappingURL=model.d.ts.map

package/model/types/test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=test.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@_tc/template-core",
-  "version": "0.0.1-bate.37",
+  "version": "0.0.1-bate.39",
   "description": "A TypeScript Koa framework template - Monorepo root",
   "main": "./index.js",
   "types": "./index.d.ts",
@@ -8,27 +8,27 @@
     ".": {
       "import": "./esm/index.js",
       "require": "./cjs/index.js",
-      "types": "./types/index.d.js"
+      "types": "./types/index.d.ts"
     },
     "./bundler": {
       "import": "./esm/bundler/index.js",
       "require": "./cjs/bundler/index.js",
-      "types": "./types/bundler/index.d.js"
+      "types": "./types/bundler/index.d.ts"
     },
     "./fe/main": {
       "import": "./fe/frontend/main.js",
       "require": "./fe/frontend/main.js",
-      "types": "./fe/frontend/main.d.js"
+      "types": "./fe/frontend/main.d.ts"
     },
     "./fe": {
       "import": "./fe/frontend/index.js",
       "require": "./fe/frontend/index.js",
-      "types": "./fe/frontend/index.d.js"
+      "types": "./fe/frontend/index.d.ts"
     },
     "./fe/rc": {
       "import": "./fe/packages/ui/react/index.js",
       "require": "./fe/packages/ui/react/index.js",
-      "types": "./fe/packages/ui/react/index.d.js"
+      "types": "./fe/packages/ui/react/index.d.ts"
     },
     "./fe/rc/*": {
       "import": "./fe/packages/ui/react/*",
@@ -40,7 +40,10 @@
       "require": "./fe/frontend/*",
       "types": "./fe/frontend/*"
     },
-    "./fe/tailwind_ui.css": "./fe/frontend/main.css"
+    "./fe/tailwind_ui.css": "./fe/frontend/main.css",
+    "./model": {
+      "types": "./model/index.d.ts"
+    }
   },
   "dependencies": {
     "@babel/runtime": "^7.27.6",

package/types/packages/utils/runFileFn.d.ts

@@ -1,5 +1,7 @@
 type AnyFun = (...p: any[]) => any;
-export declare const runFileFn: (fn: {
-    default: AnyFun;
-} | AnyFun) => AnyFun;
+type DefaultExport<T> = {
+    default?: T;
+};
+export declare function runFileFn<T = AnyFun>(file: string): T;
+export declare function runFileFn<T = AnyFun>(fileModule: DefaultExport<T> | T): T;
 export {};