import type { VbenFormProps } from '#/adapter/form'; import { $t } from '@vben/locales'; import { cloneDeep, formatDate } from '@vben/utils'; import { message } from 'ant-design-vue'; import { isFunction } from 'lodash-es'; import { dataURLtoBlob, urlToBase64 } from './base64Conver'; /** * * @deprecated 无法处理区间选择器数据 请使用commonDownloadExcel * * 下载excel文件 * @param [func] axios函数 * @param [fileName] 文件名称 不需要带xlsx后缀 * @param [requestData] 请求参数 * @param [withRandomName] 是否带随机文件名 * * @return void */ export async function downloadExcel( func: (data?: any) => Promise, fileName: string, requestData: any = {}, withRandomName = true, ) { const hideLoading = message.loading($t('pages.common.downloadLoading'), 0); try { const data = await func(requestData); downloadExcelFile(data, fileName, withRandomName); } catch (error) { console.error(error); } finally { hideLoading(); } } /** * 源码同packages\@core\ui-kit\form-ui\src\components\form-actions.vue * @param values 表单值 * @param fieldMappingTime 区间选择器 字段映射 * @returns 格式化后的值 */ function handleRangeTimeValue( values: Record, fieldMappingTime: VbenFormProps['fieldMappingTime'], ) { // 需要深拷贝 可能是readonly的 values = cloneDeep(values); if (!fieldMappingTime || !Array.isArray(fieldMappingTime)) { return values; } fieldMappingTime.forEach( ([field, [startTimeKey, endTimeKey], format = 'YYYY-MM-DD']) => { if (startTimeKey && endTimeKey && values[field] === null) { Reflect.deleteProperty(values, startTimeKey); Reflect.deleteProperty(values, endTimeKey); // delete values[startTimeKey]; // delete values[endTimeKey]; } if (!values[field]) { Reflect.deleteProperty(values, field); // delete values[field]; return; } const [startTime, endTime] = values[field]; if (format === null) { values[startTimeKey] = startTime; values[endTimeKey] = endTime; } else if (isFunction(format)) { values[startTimeKey] = format(startTime, startTimeKey); values[endTimeKey] = format(endTime, endTimeKey); } else { const [startTimeFormat, endTimeFormat] = Array.isArray(format) ? format : [format, format]; values[startTimeKey] = startTime ? formatDate(startTime, startTimeFormat) : undefined; values[endTimeKey] = endTime ? formatDate(endTime, endTimeFormat) : undefined; } // delete values[field]; Reflect.deleteProperty(values, field); }, ); return values; } export interface DownloadExcelOptions { // 是否随机文件名(带时间戳) withRandomName?: boolean; // 区间选择器 字段映射 fieldMappingTime?: VbenFormProps['fieldMappingTime']; } /** * 通用下载excel方法 * @param api 后端下载接口 * @param fileName 文件名 不带拓展名 * @param requestData 请求参数 * @param options 下载选项 */ export async function commonDownloadExcel( api: (data?: any) => Promise, fileName: string, requestData: any = {}, options: DownloadExcelOptions = {}, ) { const hideLoading = message.loading($t('pages.common.downloadLoading'), 0); try { const { withRandomName = true, fieldMappingTime } = options; // 需要处理时间字段映射 const data = await api(handleRangeTimeValue(requestData, fieldMappingTime)); downloadExcelFile(data, fileName, withRandomName); } catch (error) { console.error(error); } finally { hideLoading(); } } export function downloadExcelFile( data: BlobPart, filename: string, withRandomName = true, ) { let realFileName = filename; if (withRandomName) { realFileName = `${filename}-${Date.now()}.xlsx`; } downloadByData(data, realFileName); } /** * Download online pictures * @param url * @param filename * @param mime * @param bom */ export function downloadByOnlineUrl( url: string, filename: string, mime?: string, bom?: BlobPart, ) { urlToBase64(url).then((base64) => { downloadByBase64(base64, filename, mime, bom); }); } /** * Download pictures based on base64 * @param buf * @param filename * @param mime * @param bom */ export function downloadByBase64( buf: string, filename: string, mime?: string, bom?: BlobPart, ) { const base64Buf = dataURLtoBlob(buf); downloadByData(base64Buf, filename, mime, bom); } /** * Download according to the background interface file stream * @param {*} data * @param {*} filename * @param {*} mime * @param {*} bom */ export function downloadByData( data: BlobPart, filename: string, mime?: string, bom?: BlobPart, ) { const blobData = bom === undefined ? [data] : [bom, data]; const blob = new Blob(blobData, { type: mime || 'application/octet-stream' }); const blobURL = window.URL.createObjectURL(blob); const tempLink = document.createElement('a'); tempLink.style.display = 'none'; tempLink.href = blobURL; tempLink.setAttribute('download', filename); if (tempLink.download === undefined) { tempLink.setAttribute('target', '_blank'); } document.body.append(tempLink); tempLink.click(); tempLink.remove(); window.URL.revokeObjectURL(blobURL); } export function openWindow( url: string, opt?: { noopener?: boolean; noreferrer?: boolean; target?: '_blank' | '_self' | string; }, ) { const { noopener = true, noreferrer = true, target = '__blank' } = opt || {}; const feature: string[] = []; noopener && feature.push('noopener=yes'); noreferrer && feature.push('noreferrer=yes'); window.open(url, target, feature.join(',')); } /** * Download file according to file address * @param {*} sUrl */ export function downloadByUrl({ fileName, target = '_blank', url, }: { fileName?: string; target?: '_blank' | '_self'; url: string; }): boolean { const isChrome = window.navigator.userAgent.toLowerCase().includes('chrome'); const isSafari = window.navigator.userAgent.toLowerCase().includes('safari'); if (/iP/.test(window.navigator.userAgent)) { console.error('Your browser does not support download!'); return false; } if (isChrome || isSafari) { const link = document.createElement('a'); link.href = url; link.target = target; if (link.download !== undefined) { link.download = // eslint-disable-next-line unicorn/prefer-string-slice fileName || url.substring(url.lastIndexOf('/') + 1, url.length); } if (document.createEvent) { const e = document.createEvent('MouseEvents'); e.initEvent('click', true, true); link.dispatchEvent(e); return true; } } if (!url.includes('?')) { url += '?download'; } openWindow(url, { target }); return true; }