@hzab/utils 1.1.6 → 1.1.7

package/dist/index.d.cts

@@ -0,0 +1,741 @@
+/**
+ * 获取数组格式数据
+ * @param value
+ * @returns
+ */
+declare function getArr(value: any): any[];
+
+/**
+ * 是否是 base64 字符串
+ * @param {*} str
+ * @returns
+ */
+declare const isBase64Str: (str: any) => boolean;
+/**
+ * 从 base64 字符串获取文件类型
+ * @param base64Str
+ * @returns
+ */
+declare function getFileTypeFromBase64(base64Str: any): any;
+
+/**
+ * 通过 Blob 的文件签名判断文件类型
+ * @param {Blob} blob - 待检测的 Blob 对象
+ * @returns {Promise<string>} - 匹配的 MIME 类型或 'unknown'
+ */
+declare function getFileTypeFromBlob(blob: Blob): Promise<string>;
+
+/**
+ * 计算颜色的亮度
+ * @param r
+ * @param g
+ * @param b
+ * @returns
+ */
+declare function luminance(r: any, g: any, b: any): number;
+/**
+ * 计算两个颜色之间的对比度
+ * @param l1
+ * @param l2
+ * @returns
+ */
+declare function contrast(l1: any, l2: any): number;
+/**
+ * 计算对比度
+ * @param luminance1
+ * @param luminance2
+ * @returns
+ */
+declare function contrastRatio(luminance1: any, luminance2: any): number;
+/**
+ * 十六进制颜色转 RGB
+ * @param hex
+ * @returns
+ */
+declare function hexToRGB(hex: any): number[];
+/**
+ * rgb 数值限制
+ * @param val
+ * @returns
+ */
+declare function rgbNumLimit(val: any): any;
+/**
+ * RGB 转十六进制颜色
+ * @param r
+ * @param g
+ * @param b
+ * @returns
+ */
+declare function rgbToHex(r: any, g: any, b: any): string;
+/**
+ *  RGB 转 HSL
+ * @param r
+ * @param g
+ * @param b
+ * @returns
+ */
+declare function rgbToHsl(r: any, g: any, b: any): number[];
+/**
+ * HSL 转 RGB
+ * @param h
+ * @param s
+ * @param l
+ * @returns
+ */
+declare function hslToRgb(h: any, s: any, l: any): number[];
+/**
+ * 判断是否为灰色背景
+ * @param r
+ * @param g
+ * @param b
+ * @returns
+ */
+declare function isGray(r: any, g: any, b: any, opt?: {
+    tolerance: number;
+}): boolean;
+/**
+ *  根据背景颜色选择合适的文本颜色（十六进制格式）
+ * @param backgroundColor
+ * @returns
+ */
+declare function getTextColor(backgroundColor: any): "#ffffff" | "#000000";
+/**
+ * 根据背景亮度调整文字颜色深浅
+ * @param bgR
+ * @param bgG
+ * @param bgB
+ * @returns
+ */
+declare function adjustTextColor(hexColor: any): string;
+/**
+ * 调整颜色深浅
+ * @param hexColor
+ * @param amount
+ * @returns
+ */
+declare function adjustColor(hexColor: any, amount: any): string;
+
+interface ICheckEmptyOpt {
+    /** 【废弃】空值占位符 */
+    emptyStr?: string;
+    /** 空值占位符 */
+    emptySymbol?: string;
+    checkEmptyArr?: boolean;
+}
+interface IHandleEmptyValOpt extends ICheckEmptyOpt {
+}
+/**
+ * 空数据判断
+ * @param {*} val
+ * @param {*} opt
+ * @returns
+ */
+declare function checkEmpty(val: any, opt?: ICheckEmptyOpt): boolean;
+/**
+ * 处理空数据显示占位符
+ * @param val
+ * @param opt
+ * @returns
+ */
+declare const handleEmptyVal: (val: any, opt?: IHandleEmptyValOpt) => any;
+
+/** 获取全局配置（url、是否显示缩略图地址） */
+declare function getGlobalServeConfig(): Record<string, any>;
+/** 设置全局配置（url、是否显示缩略图地址）*/
+declare function setGlobalServeConfigs(data: any): Record<string, any>;
+/** 设置全局单个配置（url、是否显示缩略图地址）*/
+declare function setGlobalServeConfig(key: any, data: any): Record<string, any>;
+
+/**
+ * 身份证号码合法性校验
+ * @param {string} idCard 身份证号码
+ * @param {Object} opt 校验选项
+ * @param {boolean} opt.validBirthDate 是否校验出生日期
+ * @returns {boolean} 是否合法
+ */
+declare function isValidIdCard(idCard: any, opt?: any): boolean;
+/**
+ * 校验出生日期是否合法且在一定范围内
+ * @param {string} id18 18位身份证号码
+ * @returns {boolean} 出生日期是否合法
+ */
+declare function isValidBirthDate(id18: any): boolean;
+/**
+ * 获取指定月份的天数
+ * @param {number} year 年份
+ * @param {number} month 月份（1-12）
+ * @returns {number} 该月的天数
+ */
+declare function getDaysInMonth(year: any, month: any): number;
+/**
+ * 15位身份证转18位
+ * @param {string} id15 15位身份证号码
+ * @returns {string} 18位身份证号码
+ */
+declare function convert15to18(id15: any): string;
+/**
+ * 计算18位身份证的校验码
+ * @param {string} id17 身份证前17位
+ * @returns {string} 校验码（0-9或X）
+ */
+declare function calculateCheckCode(id17: any): string;
+/**
+ * 校验18位身份证的校验码
+ * @param {string} id18 18位身份证号码
+ * @returns {boolean} 校验码是否正确
+ */
+declare function verifyCheckCode(id18: any): boolean;
+/**
+ * 计算年龄
+ * @param {number} year 出生年份
+ * @param {number} month 出生月份
+ * @param {number} day 出生日期
+ * @returns {number} 年龄
+ */
+declare function calculateAge(year: any, month: any, day: any): number;
+/**
+ * 获取身份证详细信息
+ * @param {string} idCard 身份证号码
+ * @returns {object|null} 详细信息对象，校验失败返回null
+ */
+declare function getIdCardInfo(idCard: any): {
+    province: any;
+    birthDate: Date;
+    birthYear: number;
+    birthMonth: number;
+    birthDay: number;
+    age: number;
+    gender: string;
+    isValid: boolean;
+};
+
+declare class IMAGE_TYPES {
+    static JPEG: string;
+    static PNG: string;
+}
+/**
+ * 检测空图片
+ * @param img
+ * @returns
+ */
+declare function checkEmptyImg(img: HTMLImageElement): boolean;
+/**
+ * 获取dom元素宽高
+ * @param d dom元素
+ * @returns {{width: number, height: number}}
+ */
+declare function getDomWH(d: HTMLElement | HTMLImageElement | HTMLCanvasElement): {
+    width: number;
+    height: number;
+};
+/**
+ * 设置dom元素宽高
+ * @param d dom元素
+ * @param w 宽
+ * @param h 高
+ */
+declare function setDomWH(dom: HTMLElement, w: number, h: number): void;
+/**
+ * 获取当前 canvas 图片 Blob 对象
+ * @param canvas
+ * @returns {Promise<Blob>}
+ */
+declare function getCanvasPic(canvas: HTMLCanvasElement): Blob;
+/**
+ * base64 字符串转 blob
+ * @param base64
+ * @returns
+ */
+declare function dataURItoBlob(base64: string): Blob;
+/**
+ * 获取图片元素
+ * @param imgSrc
+ * @returns
+ */
+declare function getImgEle(imgSrc: string): Promise<HTMLImageElement>;
+/**
+ * 获取图片 Base64 字符串
+ * @param imgSrc
+ * @returns
+ */
+declare function getImgBase64(imgSrc: string): Promise<string>;
+/**
+ * 通过图片地址获取对应 canvas
+ * @param imgSrc
+ * @returns
+ */
+declare function getCanvas(imgSrc: string): Promise<HTMLCanvasElement>;
+/**
+ * 通过图片地址获取对应 canvas
+ * @param img
+ * @returns
+ */
+declare function getCanvasByImg(img: HTMLImageElement): HTMLCanvasElement;
+/**
+ * 截取图片
+ * @param img
+ * @param opt
+ * @param opt.startX
+ * @param opt.startY
+ * @param opt.width
+ * @param opt.height
+ * @returns Promise<string>
+ */
+declare function cropImage(img: HTMLImageElement | HTMLCanvasElement, opt: {
+    startX: number;
+    startY: number;
+    width: number;
+    height: number;
+}): string;
+/**
+ * 截取图片
+ * @param img
+ * @param opt
+ * @param opt.startX
+ * @param opt.startY
+ * @param opt.width
+ * @param opt.height
+ * @returns Promise<HTMLCanvasElement>
+ */
+declare function cropImageToCanvas(img: HTMLImageElement | HTMLCanvasElement, opt: {
+    startX: number;
+    startY: number;
+    width: number;
+    height: number;
+}): HTMLCanvasElement;
+/**
+ * 绘制图片
+ * @param img
+ * @param opt
+ * @param opt.startX
+ * @param opt.startY
+ * @param opt.width
+ * @param opt.height
+ * @returns Promise<string>
+ */
+declare function imgToCanvas(img: HTMLImageElement): HTMLCanvasElement;
+/**
+ * 缩放图片
+ * @param img
+ * @param opt
+ * @returns base64
+ */
+declare function scaleImage(img: HTMLImageElement | HTMLCanvasElement, opt?: {
+    scaleFactor: number;
+}): string;
+/**
+ * 缩放图片，返回 canvas
+ * @param img
+ * @param opt
+ * @returns canvas
+ */
+declare function scaleImageToCanvas(img: HTMLImageElement | HTMLCanvasElement, opt?: {
+    scaleFactor: number;
+}): HTMLCanvasElement;
+/**
+ * 图片转为 base64
+ * @param img
+ * @returns
+ */
+declare function imgToBase64(img: string | HTMLImageElement | HTMLCanvasElement | HTMLVideoElement): Promise<string | HTMLImageElement | HTMLCanvasElement | HTMLVideoElement>;
+/**
+ * 图片转为 Blob
+ * @param img
+ * @returns
+ */
+declare function imgToBlob(img: string | HTMLImageElement | HTMLCanvasElement | HTMLVideoElement): Promise<Blob>;
+/**
+ * 获取图片的 base64、blob 格式
+ * @param img
+ */
+declare function getAllTypeImg(img: string | HTMLImageElement | HTMLCanvasElement | HTMLVideoElement): Promise<{
+    base64: string | HTMLImageElement | HTMLCanvasElement | HTMLVideoElement;
+    blob: Blob;
+}>;
+/**
+  * 等比缩放图片尺寸（不裁切、不变形）
+  * @param {HTMLImageElement} img
+  * @param {number} scale 缩放比例 0~1
+  * @returns {Promise<Blob>}
+  */
+declare function drawScaleImage(img: any, scale: any): Promise<unknown>;
+/**
+ * JPG/WebP 仅动态降画质（不改尺寸）
+ * @param {Blob} blob
+ * @param {HTMLImageElement} img
+ * @returns {Promise<Blob>}
+ */
+declare function compressByQuality(blob: any, img: any, maxSize: any): Promise<unknown>;
+/**
+ * 智能压缩入口
+ * 1. 小于10M直接返回原图
+ * 2. JPG/WebP：只降画质，不改尺寸
+ * 3. PNG：不转格式、只等比缩分辨率，不裁切
+ * @param {Blob} blob
+ * @returns {Promise<Blob>}
+ */
+declare function smartImageCompress(blob: any, maxSize: any): Promise<any>;
+
+declare const DEFAULT_POSITION: {
+    lon: number;
+    lat: number;
+    addr: string;
+};
+/**
+ * 获取当前定位
+ * @param config
+ * @returns
+ */
+declare function getCurrentPosition(config?: any): Promise<any>;
+
+/**
+ * 指定 nanoid 字符集合
+ * 数字和大小写字母
+ */
+declare const numALetters = "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ";
+/** nanoid 数字和大小写字母 */
+declare const nanoidNumALetters: (size?: number) => string;
+/**
+ * 指定 nanoid 字符集合
+ * 数字和大小写字母
+ */
+declare const numALettersAUrl = "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ-_~";
+/** nanoid url 参数规范 */
+declare const nanoidUrl: (size?: number) => string;
+
+interface IFieldNames {
+    value?: string;
+    label?: string;
+    children?: string;
+}
+interface IFindOptionOpt extends IHandleEmptyValOpt {
+    fieldNames?: IFieldNames;
+    isPathList?: boolean;
+    pathList?: Array<any>;
+    labelList?: Array<string>;
+    parent?: any;
+}
+interface IGetArrayLabels extends IFindOptionOpt {
+    split?: string;
+}
+interface IGetValLabelOpt extends IHandleEmptyValOpt {
+    showEmpty?: boolean;
+}
+type formatOptionsOptT = {
+    fieldNames?: IFieldNames;
+    sourceFieldNames?: IFieldNames;
+    /**
+     * 是否清除其他参数
+     */
+    isClear?: boolean;
+};
+declare const DEF_FIELD_NAMES: {
+    value: string;
+    label: string;
+    children: string;
+};
+/**
+ * 获取无限级数据的选中项
+ * @param val
+ * @param options
+ * @param opt
+ * @returns
+ */
+declare const findOptionByVal: (val: any, options: any, opt?: IFindOptionOpt) => any;
+/**
+ * 在命中项上写出标准 value / label / children（保留原字段）。
+ * 与 `getOptItByVal` 的归一化语义一致；供 `normalizeOption(findOptionByVal(...))` 组合使用。
+ * @param item 命中的 option 项
+ * @param fieldNames 自定义字段名映射
+ */
+declare function normalizeOption<T extends Record<string, any>>(item: T, fieldNames?: IFieldNames): T & {
+    value: unknown;
+    label: unknown;
+    children: unknown;
+};
+/**
+ * 获取 options 中 val 对应的 label
+ * @param {*} val
+ * @param {Array<Object>} options
+ * @param {Object} opt
+ * @returns
+ */
+declare const getOptionLabel: (val: any, options?: any[], opt?: IFindOptionOpt) => any;
+/**
+ * 获取 options 中的指定项 的 label
+ * @param {*} val
+ * @param {*} options
+ * @param {*} opt
+ * @returns
+ */
+declare function getValLabel(val: any, options?: any[], opt?: IGetValLabelOpt): any;
+/**
+ * 获取 options 中的指定项 的 label 数组
+ * @param {*} values
+ * @param {*} options
+ * @param {*} opt
+ * @returns
+ */
+declare function getArrayLabels(values: any, options: any, opt?: IGetArrayLabels): any;
+/**
+ * 格式化 options 数组
+ */
+declare const formatOptions: (options: any, opt?: formatOptionsOptT) => any;
+/**
+ * 根据 val 获取对应的 options 项数据，并进行数据归一化处理
+ * value, label, children
+ * @param {string|number|boolean} val
+ * @param {Object} field
+ */
+declare const getOptItByVal: (val: any, options: any, opt: any) => any;
+
+interface CodeOptProps {
+    baseUrl?: string;
+    env: "test" | "prod";
+}
+/**
+ * 获取二维码信息
+ * @param id 二维码ID（字符串或数字类型）
+ * @param opt 配置项
+ * @returns Promise 对象，便于外部处理异步逻辑
+ */
+declare const getCodeInfo: (id: string | number, opt: CodeOptProps) => Promise<unknown>;
+/**
+ * 设置二维码信息
+ * @param value 二维码信息对象
+ * @param opt 配置项
+ * @returns Promise 对象，便于外部处理异步逻辑
+ */
+declare const setCodeInfo: (value: object, opt: CodeOptProps) => Promise<unknown>;
+
+/**
+ * 获取视窗宽高
+ * @returns
+ */
+declare function getClientStyle(): {
+    width: number;
+    height: number;
+};
+/**
+ * 视窗宽高
+ */
+declare const clientStyle: {
+    width: number;
+    height: number;
+};
+/**
+ * 获取当前视窗 1vw、1vh 对应的 px
+ */
+declare function getViewportPX(): {
+    wPx: number;
+    hPx: number;
+};
+declare const DEFAULT_SIZE: {
+    width: number;
+    height: number;
+};
+declare function setDefaultSize(width: any, height: any): void;
+/**
+ * 获取视窗与视觉稿的比例
+ * @param current
+ * @param defaultVal
+ * @returns
+ */
+declare function getClientRate(current: any, defaultVal: any): number;
+/**
+ * 获取默认宽度对应的 vw 值
+ */
+declare function getVW(pxNum?: number): string;
+/**
+ * 获取默认高度对应的 vh 值
+ */
+declare function getVH(pxNum?: number): string;
+/**
+ * 获取默认宽度对应的 px 值
+ * 适用于必须传入 px 值的情况，如 ECharts
+ */
+declare function getWpx(pxNum?: number): number;
+/**
+ * 获取默认高度对应的 px 值
+ * 适用于必须传入 px 值的情况，如 ECharts
+ */
+declare function getHpx(pxNum?: number): number;
+/**
+ * 通过 vw 获取对应的 px
+ * @param {number} vw
+ */
+declare function getHPxByVW(vw?: number): number;
+/**
+ * 通过 vh 获取对应的 px
+ * @param {number} vh
+ */
+declare function getWPxByVH(vh?: number): number;
+
+/**
+ * 字符串中划线转为小驼峰
+ * @param s
+ * @returns
+ */
+declare const convertToCamelCase: (s: any) => any;
+/**
+ * 对象字符串转为对象
+ * @param objStr
+ */
+declare const objStrToObj: (objStr: any) => any;
+
+/**
+ * 替换 search 字符串
+ * @param url
+ * @param search
+ * @returns
+ */
+declare function replaceSearch(url: string, search: string): any;
+/**
+ * 把对象转为 query 参数
+ * @param query
+ */
+declare function objToSearch(query: any, opt: any): string;
+/**
+ * 修复 query，解决 query 在 hash 后面的情况
+ * @param url
+ * @returns
+ * 源数据：/#/login?a=1&b=2
+ * 结果：/?a=1&b=2#/login
+ */
+declare function fixUrlQuery(url: any): any;
+/**
+ * 获取 url 中的 query 值的对象
+ * 支持：完整 URL、`?a=1`、`&a=1`、纯 `a=1&b=2`
+ * @param query
+ */
+declare function searchToObj(url: any): {};
+/**
+ * 添加 url 中的 query 的参数
+ * @param url
+ * @param params
+ * @param opt.isEncode 是否对 key/value 做 encodeURIComponent（默认 false，保持 1.x 既有输出）
+ * @returns url string
+ */
+declare function addQuery(url: any, params: any, opt?: {
+    isEncode?: boolean;
+}): any;
+/**
+ * 添加 url 中的 query 参数，返回 search
+ * @param url
+ * @param params
+ * @param opt.isEncode 是否对 key/value 做 encodeURIComponent（默认 false，保持 1.x 既有输出）
+ * @returns search string
+ */
+declare function addSearch(url: string, params: Record<string, unknown>, opt?: {
+    isEncode?: boolean;
+}): string;
+
+/**
+ * 获取文件后缀
+ * @param fileUrl
+ * @returns
+ */
+declare function getFileExt(fileUrl: any): string;
+/**
+ * 从 url 获取文件名称，不包含后缀
+ * @param {string} fileName
+ * @param {string} str
+ * @returns
+ */
+declare function getFileName(fileUrl: any): string;
+/**
+ * 从 url 获取文件名称，包含后缀
+ * @param {string} fileName
+ * @param {string} str
+ * @returns
+ */
+declare function getFullFileName(fileUrl: any): string;
+/**
+ * 合并文件名称，自动处理后缀
+ * @param {string} fileName
+ * @param {string} str
+ * @returns
+ */
+declare const mergeFileName: (fileName: any, str?: string) => string;
+/**
+ * 获取唯一的文件名
+ * @param {string} fileName
+ * @returns
+ */
+declare const getUFileName: (fileName: any) => string;
+/**
+ * 获取文件名的后缀
+ * @param fileName
+ * @returns
+ */
+declare const getFileNameExt: (fileName: any) => {
+    mainPart: any;
+    ext: any;
+};
+
+declare const TYPE_VIDEO = "video";
+declare const TYPE_IMG = "image";
+declare const TYPE_AUDIO = "audio";
+/**
+ * 检查 url 是否带有指定后缀
+ * @param {string} url url 地址
+ * @param {Array} types 后缀数组
+ * @returns
+ */
+declare function checkUrlSuffix(url: any, types?: any[], caseSensitive?: boolean): boolean;
+/**
+ * 获取文件类型（文件自身类型，如：video/mp4、image/jpeg）
+ * @param file
+ * @returns
+ */
+declare function getFileType(file: any): any;
+/**
+ * 判断 url 是否带有指定图片后缀
+ * @param {string} url
+ * @returns
+ */
+declare function checkImageUrl(url: any): boolean;
+/**
+ * 判断是否是合法的媒体类型
+ * @param {String} input
+ * @returns
+ */
+declare function isValidMediaType(input: any): boolean;
+/**
+ * 判断 url 是否带有指定视频后缀
+ * @param {string} url
+ * @returns
+ */
+declare function checkVideoUrl(url: any): boolean;
+/**
+ * 判断 url 是否带有指定音频后缀
+ * @param {string} url
+ * @returns
+ */
+declare function checkAudioUrl(url: any): boolean;
+/**
+ * 获取文件类型（项目内部枚举，如：图片-image、视频-video）
+ * @param file
+ * @returns
+ */
+declare function getFileTypeStr(file: any): any;
+/**
+ * 根据文件的 MIME 类型 (file.type) 获取对应的文件后缀名
+ * @param {string} mimeType - 文件的 MIME 类型（如 'image/jpeg'、'application/pdf'）
+ * @returns {string} 返回文件后缀名（带点，如 '.jpg'），未知类型返回 '.unknown'
+ */
+declare const getFileTypeExt: (mimeType: any) => any;
+
+interface IFile extends File {
+    file?: IFile;
+    url?: string;
+}
+/**
+ *  建立一个可以存取该 file 的 url
+ * @param {Object} file 文件
+ * @returns {string} url
+ * blob:http://localhost:8000/c9950644-5118-4231-9be7-8183bde1fdc7
+ */
+declare function getFileURL(file: IFile): string;
+
+export { DEFAULT_POSITION, DEFAULT_SIZE, DEF_FIELD_NAMES, type ICheckEmptyOpt, type IFieldNames, type IFile, type IFindOptionOpt, type IGetArrayLabels, type IGetValLabelOpt, type IHandleEmptyValOpt, IMAGE_TYPES, TYPE_AUDIO, TYPE_IMG, TYPE_VIDEO, addQuery, addSearch, adjustColor, adjustTextColor, calculateAge, calculateCheckCode, checkAudioUrl, checkEmpty, checkEmptyImg, checkImageUrl, checkUrlSuffix, checkVideoUrl, clientStyle, compressByQuality, contrast, contrastRatio, convert15to18, convertToCamelCase, cropImage, cropImageToCanvas, dataURItoBlob, drawScaleImage, findOptionByVal, fixUrlQuery, formatOptions, type formatOptionsOptT, getAllTypeImg, getArr, getArrayLabels, getCanvas, getCanvasByImg, getCanvasPic, getClientRate, getClientStyle, getCodeInfo, getCurrentPosition, getDaysInMonth, getDomWH, getFileExt, getFileName, getFileNameExt, getFileType, getFileTypeExt, getFileTypeFromBase64, getFileTypeFromBlob, getFileTypeStr, getFileURL, getFullFileName, getGlobalServeConfig, getHPxByVW, getHpx, getIdCardInfo, getImgBase64, getImgEle, getOptItByVal, getOptionLabel, getTextColor, getUFileName, getVH, getVW, getValLabel, getViewportPX, getWPxByVH, getWpx, handleEmptyVal, hexToRGB, hslToRgb, imgToBase64, imgToBlob, imgToCanvas, isBase64Str, isGray, isValidBirthDate, isValidIdCard, isValidMediaType, luminance, mergeFileName, nanoidNumALetters, nanoidUrl, normalizeOption, numALetters, numALettersAUrl, objStrToObj, objToSearch, replaceSearch, rgbNumLimit, rgbToHex, rgbToHsl, scaleImage, scaleImageToCanvas, searchToObj, setCodeInfo, setDefaultSize, setDomWH, setGlobalServeConfig, setGlobalServeConfigs, smartImageCompress, verifyCheckCode };