joy-admin-components 0.2.104 → 0.2.106

package/src/utils/index.d.ts

@@ -17,10 +17,9 @@ export interface ValidatorOptions {
  */
 export function creatValidator(
   type: 'phone' | 'password' | 'email',
-  opt?: ValidatorOptions
+  opt?: ValidatorOptions,
 ): boolean | ((rule: any, value: any, callback: any) => void);
 
-
 // Excel 工具类型
 export interface ImportExcelOptions {
   /** 其他选项 */
@@ -50,7 +49,7 @@ export function exportExcel(
   tableName: string,
   tableHeader: any[],
   tableData?: any[],
-  options?: ExportExcelOptions
+  options?: ExportExcelOptions,
 ): Promise<void>;
 
 /**
@@ -73,7 +72,7 @@ export interface ImportExcelMuiltiOptions {
  */
 export function importExcelMuilti(
   file: File,
-  options: ImportExcelMuiltiOptions
+  options: ImportExcelMuiltiOptions,
 ): Promise<Record<string, any[]>>;
 
 /**
@@ -115,7 +114,7 @@ export interface ExportExcelMuiltiSheet {
  */
 export function exportExcelMuilti(
   tableName: string,
-  sheets: Record<string, ExportExcelMuiltiSheet>
+  sheets: Record<string, ExportExcelMuiltiSheet>,
 ): Promise<void>;
 
 // 单点登录 SDK 类型
@@ -142,7 +141,7 @@ export function formatNumber(
   num: number | string,
   decimals?: number,
   decimalSeparator?: string,
-  thousandSeparator?: string
+  thousandSeparator?: string,
 ): string;
 
 /**
@@ -324,7 +323,7 @@ export interface UseRequestOptions {
  */
 export function useRequest(
   apiHandle: (params?: any) => Promise<any>,
-  opt?: UseRequestOptions
+  opt?: UseRequestOptions,
 ): [Ref<boolean>, Ref<any>, (params?: any) => void];
 
 /**
@@ -422,7 +421,7 @@ export function useI18nReState<T>(state: () => T, otherWatch?: any[]): Ref<T>;
 export function getLocaleValue(
   sourceData: Record<string, any> | null | undefined,
   zh?: string,
-  en?: string
+  en?: string,
 ): string;
 
 // storeHook.js hooks
@@ -433,7 +432,10 @@ export function getLocaleValue(
  * @param mapper state 映射对象或数组
  * @returns 响应式 state 对象
  */
-export function useState(moduleName: string, mapper: string[] | Record<string, any>): Record<string, Ref<any>>;
+export function useState(
+  moduleName: string,
+  mapper: string[] | Record<string, any>,
+): Record<string, Ref<any>>;
 export function useState(mapper: string[] | Record<string, any>): Record<string, Ref<any>>;
 
 /**
@@ -442,7 +444,10 @@ export function useState(mapper: string[] | Record<string, any>): Record<string,
  * @param mapper getters 映射对象或数组
  * @returns 响应式 getters 对象
  */
-export function useGetters(moduleName: string, mapper: string[] | Record<string, any>): Record<string, Ref<any>>;
+export function useGetters(
+  moduleName: string,
+  mapper: string[] | Record<string, any>,
+): Record<string, Ref<any>>;
 export function useGetters(mapper: string[] | Record<string, any>): Record<string, Ref<any>>;
 
 /**
@@ -451,5 +456,89 @@ export function useGetters(mapper: string[] | Record<string, any>): Record<strin
  * @param mapper actions 映射对象或数组
  * @returns actions 对象
  */
-export function useActions(moduleName: string, mapper: string[] | Record<string, any>): Record<string, (...args: any[]) => any>;
+export function useActions(
+  moduleName: string,
+  mapper: string[] | Record<string, any>,
+): Record<string, (...args: any[]) => any>;
 export function useActions(mapper: string[] | Record<string, any>): Record<string, (...args: any[]) => any>;
+
+/**
+ * 将下拉列表国际化
+ * 根据当前语言环境自动切换 label/labelEn 的显示
+ * @param arr 数据源数组（支持 Ref 或普通数组）
+ * @param keys 字段映射 [label, value, labelEn]，默认 ['label', 'value', 'labelEn']
+ * @returns 计算属性，包含国际化后的列表数据
+ *
+ * @example
+ * ```ts
+ * const statusList = ref([
+ *   { label: '启用', value: 1, labelEn: 'Enabled' },
+ *   { label: '禁用', value: 0, labelEn: 'Disabled' }
+ * ]);
+ * const options = useVxeEditRenderStatus(statusList, ['label', 'value', 'labelEn']);
+ * ```
+ */
+export function useVxeEditRenderStatus(
+  arr: any[] | Ref<any[]>,
+  keys?: [string?, string?, string?],
+): import('vue').ComputedRef<Array<{ label: string; value: any; [key: string]: any }>>;
+
+// ============== Excel 额外工具函数类型 ==============
+
+/**
+ * 根据列下标获取列头字母
+ * @param index 列下标，从 0 开始
+ * @returns 对应的列头字母，如 A, B, ..., Z, AA, AB...
+ *
+ * @example
+ * getColumnLetterByIndex(0)  // 'A'
+ * getColumnLetterByIndex(25) // 'Z'
+ * getColumnLetterByIndex(26) // 'AA'
+ */
+export function getColumnLetterByIndex(index: number): string;
+
+/**
+ * 将 base64 图片转换为 Blob 对象
+ * @param base64 base64 格式的图片数据
+ * @returns Blob 对象
+ */
+export function base64ToBlob(base64: string): Blob;
+
+/**
+ * 将 base64 图片转换为 File 对象
+ * @param base64 base64 格式的图片数据
+ * @param filename 文件名，默认 'image.png'
+ * @returns File 对象
+ */
+export function base64ToFile(base64: string, filename?: string): File;
+
+/**
+ * 将 base64 图片转换为 FormData 对象，可直接用于上传接口
+ * @param base64 base64 格式的图片数据
+ * @param filename 文件名，默认根据图片类型自动生成
+ * @returns FormData 对象
+ */
+export function base64ToFormData(base64: string, filename?: string): FormData;
+
+/**
+ * 获取 VxeTable 当前显示的列字段列表
+ *
+ * 从 localStorage 中读取 VxeTable 的自定义列配置（VXE_CUSTOM_STORE），
+ * 返回当前表格排序后且可见的列字段 key 数组（排除 checkbox、action/actions 列）。
+ *
+ * @param tableId ListPage 的 id，用于匹配 localStorage 中的配置
+ * @returns 当前显示的列字段 key 数组
+ *
+ * @example
+ * ```ts
+ * import { getTableShowColumn } from 'joy-admin-components';
+ *
+ * // 获取 id 为 'orderList' 的表格当前显示列
+ * const showColumns = getTableShowColumn('orderList');
+ * // ['orderNo', 'customerName', 'amount', 'status', 'createTime']
+ *
+ * // 配合导出功能，只导出用户可见的列
+ * const exportHeaders = allHeaders.filter(h => showColumns.includes(h.key));
+ * ```
+ */
+export function getTableShowColumn(tableId?: string): string[];