@jhqn/utils-core 0.0.1-beta.9 → 0.0.2-beta.0

package/dist/index.d.ts

@@ -1,3 +1,12 @@
+/// <reference types="dayjs/plugin/localeData" />
+/// <reference types="dayjs/plugin/duration" />
+/// <reference types="dayjs/plugin/relativeTime" />
+/// <reference types="dayjs/plugin/customParseFormat" />
+/// <reference types="dayjs/plugin/objectSupport" />
+import * as detect_browser from 'detect-browser';
+import { ConfigType } from 'dayjs';
+export { Dayjs, default as dayjs } from 'dayjs';
+
 /**
  * snake2Kebab
  * @param {string} str 字符串
@@ -212,39 +221,289 @@ declare type Undefinable<T> = T | undefined;
  * 可 Null 或 Undefined
  */
 declare type NullOrUndefinable<T> = Nullable<Undefinable<T>>;
+/**
+ * alias for NullOrUndefinable
+ */
+declare type UnDef<T> = NullOrUndefinable<T>;
+/**
+ * 请求结果
+ */
+declare type Res<T = any> = Service.Response<T>;
+/**
+ * 分页请求结果数据
+ */
+declare type PageResData<T = any> = Service.PageResponseData<T>;
+/**
+ * 分页请求结果
+ */
+declare type PageRes<T = any> = Service.PageResponse<T>;
+/**
+ * 可能是数组
+ */
+declare type MaybeArray<T = any> = T | Array<T>;
 
+/**
+ * 隐藏中间部分
+ * @param {string} str 需要隐藏的字符串
+ */
+declare const hideMiddle: (str: UnDef<string>) => string;
+/**
+ * 隐藏首尾仅保留中间3分之1
+ * @param {string} str 需要隐藏的字符串
+ */
+declare const hideThird: (str: UnDef<string>) => string;
+/**
+ * 隐藏首部
+ * @param {string} str 需要隐藏的字符串
+ * @param {number} count 隐藏的字符数
+ */
+declare const hideHead: (str: UnDef<string>, count?: number) => string;
+/**
+ * 隐藏尾部
+ * @param {string} str 需要隐藏的字符串
+ * @param {number} count 隐藏的字符数
+ */
+declare const hideTail: (str: UnDef<string>, count?: number) => string;
 /**
  * 隐藏手机号
- * @param str
+ * @param {string} phone 手机号
  */
-declare const hidePhone: (str: NullOrUndefinable<string>) => string;
+declare const hidePhone: (phone: UnDef<string>) => string;
 /**
  * 隐藏身份证号
- * @param cardNo
+ * @param {string} cardNo 身份证号
+ * @param {boolean} strong 是否强化隐藏
  */
-declare const hideCardNo: (cardNo: NullOrUndefinable<string>) => string;
+declare const hideCardNo: (cardNo: UnDef<string>, strong?: boolean) => string;
 /**
- * 隐藏姓名
- * @param name
+ * 隐藏姓名第一个字
+ * @param {string} name 姓名
+ * @deprecated 请使用 hideSurname
  */
-declare const hideName: (name: NullOrUndefinable<string>) => string;
+declare const hideName: (name: UnDef<string>) => string;
 /**
- * 隐藏中间部分
- * @param str
+ * 隐藏姓氏
+ * @param {string} name 姓名
  */
-declare const hideMiddle: (str: NullOrUndefinable<string>) => string;
+declare const hideSurname: (name: UnDef<string>) => string;
 /**
- * 隐藏首尾仅保留中间3分之1
- * @param str
+ * 隐藏名字
+ * @param {string} name 姓名
+ */
+declare const hideFirstName: (name: UnDef<string>) => string;
+/**
+ * 隐藏邮箱
+ * @param {string} email 邮箱
+ */
+declare const hideEmail: (email: UnDef<string>) => string;
+/**
+ * 隐藏银行卡号
+ * @param {string} bankCard 银行卡号
  */
-declare const hideThird: (str: NullOrUndefinable<string>) => string;
+declare const hideBankCard: (bankCard: UnDef<string>) => string;
+
+/**
+ * 判断是否是浏览器环境
+ */
+declare const inBrowser: boolean;
+/**
+ * 等待一段时间
+ * @param time
+ */
+declare const waitTime: (time?: number) => Promise<unknown>;
+/**
+ * 防止 iOS 因输入框字体小于16px 而在 focus 时页面缩放变大需要手动回正的情况。
+ * iOS 10+ 允许 pinch-zoom， 即使 viewport 是不可伸缩的。
+ * 只对这些浏览器添加额外规则
+ */
+declare const fixiOSInputAutoZoomIn: () => void;
+/**
+ * 用户代理
+ */
+declare const userAgent: string;
+/**
+ * 获取宿主环境信息
+ */
+declare const getHostEnv: () => {
+    /**
+     * 是否是浙里办
+     */
+    zlb: boolean;
+    /**
+     * 是否是专有钉
+     */
+    zyd: boolean;
+    /**
+     * 是否是浙政钉
+     */
+    zzd: boolean;
+    /**
+     * 是否是微信
+     */
+    wx: boolean;
+    /**
+     * 是否是支付宝
+     */
+    zfb: boolean;
+    /**
+     * 是否是小程序
+     */
+    mini: boolean;
+} | {
+    /**
+     * 是否是浙里办
+     */
+    zlb: boolean;
+    /**
+     * 是否是专有钉
+     */
+    zyd: boolean;
+    /**
+     * 是否是浙政钉
+     */
+    zzd: boolean;
+    /**
+     * 是否是微信
+     */
+    wx: boolean;
+    /**
+     * 是否是支付宝
+     */
+    zfb: boolean;
+    /**
+     * 是否是小程序
+     */
+    mini: boolean;
+    name: detect_browser.Browser;
+    version: string;
+    os: detect_browser.OperatingSystem | null;
+    type: "browser";
+} | {
+    /**
+     * 是否是浙里办
+     */
+    zlb: boolean;
+    /**
+     * 是否是专有钉
+     */
+    zyd: boolean;
+    /**
+     * 是否是浙政钉
+     */
+    zzd: boolean;
+    /**
+     * 是否是微信
+     */
+    wx: boolean;
+    /**
+     * 是否是支付宝
+     */
+    zfb: boolean;
+    /**
+     * 是否是小程序
+     */
+    mini: boolean;
+    name: detect_browser.Browser;
+    version: string;
+    os: detect_browser.OperatingSystem | null;
+    bot: string;
+    type: "bot-device";
+} | {
+    /**
+     * 是否是浙里办
+     */
+    zlb: boolean;
+    /**
+     * 是否是专有钉
+     */
+    zyd: boolean;
+    /**
+     * 是否是浙政钉
+     */
+    zzd: boolean;
+    /**
+     * 是否是微信
+     */
+    wx: boolean;
+    /**
+     * 是否是支付宝
+     */
+    zfb: boolean;
+    /**
+     * 是否是小程序
+     */
+    mini: boolean;
+    type: "bot";
+    bot: true;
+    name: "bot";
+    version: null;
+    os: null;
+} | {
+    /**
+     * 是否是浙里办
+     */
+    zlb: boolean;
+    /**
+     * 是否是专有钉
+     */
+    zyd: boolean;
+    /**
+     * 是否是浙政钉
+     */
+    zzd: boolean;
+    /**
+     * 是否是微信
+     */
+    wx: boolean;
+    /**
+     * 是否是支付宝
+     */
+    zfb: boolean;
+    /**
+     * 是否是小程序
+     */
+    mini: boolean;
+    version: string;
+    type: "node";
+    name: "node";
+    os: NodeJS.Platform;
+} | {
+    /**
+     * 是否是浙里办
+     */
+    zlb: boolean;
+    /**
+     * 是否是专有钉
+     */
+    zyd: boolean;
+    /**
+     * 是否是浙政钉
+     */
+    zzd: boolean;
+    /**
+     * 是否是微信
+     */
+    wx: boolean;
+    /**
+     * 是否是支付宝
+     */
+    zfb: boolean;
+    /**
+     * 是否是小程序
+     */
+    mini: boolean;
+    type: "react-native";
+    name: "react-native";
+    version: null;
+    os: null;
+};
 
 /**
  * Json字符串转对象
  * @param str
  * @param reviver
  */
-declare const parseToJSON: <T = any>(str: string, reviver?: ((this: any, key: string, value: any) => any) | undefined) => T | null;
+declare const parseToJSON: <T = any>(str: string, reviver?: ((this: any, key: string, value: any) => any) | undefined) => Nullable<T>;
 /**
  * JSON.stringify() second param
  * @param _
@@ -268,40 +527,336 @@ declare const filterObj: (obj: Record<string, any>, keys: string[], reverse?: bo
 };
 
 /**
- * 是否有意义的值
- * @param val
+ * 格式化时间
+ * @param {import('dayjs').ConfigType} date 时间
+ * @param {string} format 格式
+ * @returns {string} 格式化后的时间
+ */
+declare const dateFmt: (date: ConfigType, format?: string | 'date' | 'datetime') => string;
+/**
+ * 格式化时间间隔
+ * @param {import('dayjs').ConfigType} start 开始时间
+ * @param {import('dayjs').ConfigType} end 结束时间
+ */
+declare const dateDuration: (start: ConfigType, end: ConfigType) => string;
+
+/**
+ * 设置文件基本路径
+ * @param key
+ * @param baseUrl
+ */
+declare function setBaseAttachUrl(baseUrl: string): void;
+/**
+ * 获取文件基本路径
+ */
+declare function getBaseAttachUrl(): string;
+
+/**
+ * 千位分隔符
+ * @param num
+ */
+declare const toThousands: (num: number) => string | undefined;
+/**
+ * 货币格式化
+ * @param {number | string | bigint} currency - 金额
+ * @param {number} [maximumFractionDigits] - 小数位数
+ */
+declare const currencyFmt: (currency: UnDef<Numeric | bigint>, maximumFractionDigits?: number) => string;
+
+type VantUploadFileStatus = '' | 'uploading' | 'done' | 'failed'
+type AntdUploadFileStatus = 'removed' | 'uploading' | 'done' | 'error'
+type ElementPlusUploadFileStatus = 'ready' | 'uploading' | 'success' | 'fail'
+
+interface Resource {
+  /** origin */
+  group: string
+  id: string
+  name: string
+  uri: string
+  /** extend */
+  url?: string
+  size?: number
+  uid?: string
+  status?: VantUploadFileStatus | AntdUploadFileStatus | ElementPlusUploadFileStatus
+  /** vant */
+  objectUrl?: string
+  content?: string
+  isImage?: boolean
+  message?: string
+  deletable?: boolean
+  reupload?: boolean
+  /** antd */
+  fileName?: string
+  percent?: number
+  thumbUrl?: string
+  /** element-plus */
+  percentage?: number
+}
+
+/**
+ * 获取文件完整地址
+ * @param url
+ */
+declare const resUrl: (url: Undefinable<string>) => string | undefined;
+/**
+ * 统一文件字段内容
+ * @param resource
+ */
+declare const recoverFile: (resource: Resource) => {
+    url: string | undefined;
+    content: string | undefined;
+    uri: string;
+    status: string;
+    percent: number;
+    group: string;
+    id: string;
+    name: string;
+    size?: number | undefined;
+    uid?: string | undefined;
+    objectUrl?: string | undefined;
+    isImage?: boolean | undefined;
+    message?: string | undefined;
+    deletable?: boolean | undefined;
+    reupload?: boolean | undefined;
+    fileName?: string | undefined;
+    thumbUrl?: string | undefined; /**
+     * 统一文件字段内容
+     * @param resource
+     */
+    percentage?: number | undefined;
+};
+/**
+ * 附件格式
+ * @param data
+ */
+declare const attachFmt: (data: UnDef<MaybeArray<Resource>> | string) => {
+    url: string | undefined;
+    content: string | undefined;
+    uri: string;
+    status: string;
+    percent: number;
+    group: string;
+    id: string;
+    name: string;
+    size?: number | undefined;
+    uid?: string | undefined;
+    objectUrl?: string | undefined;
+    isImage?: boolean | undefined;
+    message?: string | undefined;
+    deletable?: boolean | undefined;
+    reupload?: boolean | undefined;
+    fileName?: string | undefined;
+    thumbUrl?: string | undefined; /**
+     * 统一文件字段内容
+     * @param resource
+     */
+    percentage?: number | undefined;
+}[];
+
+/**
+ * 检测变量类型
+ * @param {any} val 检测的目标
+ */
+declare const getVariableType: (val: any) => string | undefined;
+/**
+ * 是否是数字
+ * @param {any} val 检测的目标
+ */
+declare const isNumber: (val: any) => val is number;
+/**
+ * 是否是字符串
+ * @param {any} val 检测的目标
+ */
+declare const isString: (val: any) => val is string;
+/**
+ * 是否是布尔值
+ * @param {any} val 检测的目标
+ */
+declare const isBoolean: (val: any) => val is boolean;
+/**
+ * 是否是null
+ * @param {any} val 检测的目标
+ */
+declare const isNull: (val: any) => val is null;
+/**
+ * 是否是undefined
+ * @param {any} val 检测的目标
+ */
+declare const isUndefined: (val: any) => val is undefined;
+/**
+ * 是否是symbol
+ * @param {any} val 检测的目标
+ */
+declare const isSymbol: (val: any) => val is symbol;
+/**
+ * 是否是对象
+ * @param {any} val 检测的目标
+ */
+declare const isObject: (val: any) => val is Record<any, any>;
+/**
+ * 是否是数组
+ * @param {any} val 检测的目标
+ */
+declare const isArray: (val: any) => val is any[];
+/**
+ * 是否是函数
+ * @param {any} val 检测的目标
+ */
+declare const isFunction: (val: any) => val is Function;
+/**
+ * 是否是日期
+ * @param {any} val 检测的目标
+ */
+declare const isDate: (val: any) => val is Date;
+/**
+ * 是否是正则
+ * @param {any} val 检测的目标
+ */
+declare const isRegExp: (val: any) => val is RegExp;
+/**
+ * 是否是期望（Promise）
+ * @param {any} val 检测的目标
+ */
+declare const isPromise: (val: any) => val is Promise<any>;
+/**
+ * 是否是集合（Set）
+ * @param {any} val 检测的目标
+ */
+declare const isSet: (val: any) => val is Set<any>;
+/**
+ * 是否是映射（Map）
+ * @param {any} val 检测的目标
+ */
+declare const isMap: (val: any) => val is Map<any, any>;
+/**
+ * 是否是弱集合（WeakSet）
+ * @param {any} val 检测的目标
+ */
+declare const isWeakSet: (val: any) => val is WeakSet<any>;
+/**
+ * 是否是弱映射（WeakMap）
+ * @param {any} val 检测的目标
+ */
+declare const isWeakMap: (val: any) => val is WeakMap<any, any>;
+/**
+ * 是否是File
+ * @param {any} val 检测的目标
+ */
+declare const isFile: (val: any) => val is File;
+/**
+ * 是否是Blob
+ * @param {any} val 检测的目标
+ */
+declare const isBlob: (val: any) => val is Blob;
+/**
+ * 是否是URL
+ * @param {any} val 检测的目标
+ */
+declare const isURL: (val: any) => val is URL;
+/**
+ * 是否是错误（Error）
+ * @param {any} val 检测的目标
+ */
+declare const isError: (val: any) => val is Error;
+/**
+ * 是否既不是 null 也不是 undefined
+ * @param {any} val 检测的目标
  */
 declare const isDef: <T>(val: T) => val is NonNullable<T>;
 /**
  * 是否是数字或字符
  * @param val
  */
-declare const isNumeric: (val: Numeric) => val is string;
+declare const isNumeric: (val: UnDef<Numeric>) => val is string;
 /**
  * 是否是需要的图片格式
  * @param ext
  */
 declare const checkImg: (ext?: string) => boolean;
+/**
+ * 是否是空值/空数组/空对象 null undefined '' [] {} Set Map
+ * @param val
+ */
+declare const isEmpty: (val: UnDef<Numeric | boolean | Record<any, any> | Array<any> | Set<any> | Map<any, any>>) => boolean;
 /**
  * 判断是否合法JSON字符串
  * @param str
  */
-declare const isJSONStr: (str: string) => boolean;
+declare const isJSONStr: (str: UnDef<string>) => boolean;
 /**
  * 判断是否合法JSON数组字符串
  * @param str
  */
-declare const isArrStr: (str: string) => boolean;
+declare const isArrStr: (str: UnDef<string>) => boolean;
+/**
+ * 判断是否有效的key
+ * @param {string | number | symbol} key 键名
+ * @param {object} object 对象
+ * @example
+ *
+ * ```ts
+ * const obj = { a: 1, b: 2 }
+ * isValidKey('a', obj) // true
+ * ```
+ * @returns {boolean} boolean
+ */
 declare const isValidKey: (key: string | number | symbol, object: object) => key is never;
 /**
  * 是否是中国手机号
  * @param val
  */
-declare const isPhone: (val: NullOrUndefinable<Numeric>) => boolean;
+declare const isPhone: (val: UnDef<Numeric>) => boolean;
 /**
  * 是否是中国座机号
  * @param val
  */
-declare const isTel: (val: NullOrUndefinable<Numeric>) => boolean;
+declare const isTel: (val: UnDef<Numeric>) => boolean;
+/**
+ * 是否是邮箱
+ * @param val
+ */
+declare const isEmail: (val: UnDef<string>) => boolean;
+/**
+ * 是否是身份证
+ * @param {string|null|undefined} val 身份证号
+ * @param {boolean} compatible 兼容15位
+ */
+declare const isIdCard: (val: UnDef<string>, compatible?: boolean) => boolean;
+/**
+ * 包含非ASCII字符
+ * @param text
+ */
+declare const nonASCII: (text: string) => boolean;
+/**
+ * 校验接口返回code
+ * @param res
+ * @param code
+ */
+declare const isValidResCode: (res: Res, code?: number) => boolean;
+/**
+ * 校验接口返回内容
+ * @param res
+ * @param code
+ */
+declare const isValidRes: (res: Res, code?: number) => boolean;
+/**
+ * 校验接口数组返回内容
+ * @param res
+ * @param code
+ */
+declare const isValidArrRes: (res: Res<any[]>, code?: number) => boolean;
+/**
+ * 校验接口分页返回内容
+ * @param res
+ * @param code
+ */
+declare const isValidPageRes: (res: PageRes, code?: number) => boolean;
+/**
+ * 校验文件类型
+ * 1. XXX/YYY 2. .xxx 3. XXX/* 4.*
+ * @param {File} file 需要校验的文件
+ * @param {string} type 文件类型, 与input.accept一致
+ */
+declare const isValidFileType: (file: File, type: string) => boolean;
 
-export { NullOrUndefinable, Nullable, Numeric, Undefinable, camel2Kebab, camel2Pascal, camel2Snake, camel2Title, checkImg, filterObj, hideCardNo, hideMiddle, hideName, hidePhone, hideThird, isArrStr, isDef, isJSONStr, isNumeric, isPhone, isTel, isValidKey, jClear, jDebug, jError, jGroup, jGroupC, jGroupE, jInfo, jLog, jTime, jTimeEnd, jWarn, kebab2Camel, kebab2Pascal, kebab2Snake, kebab2Title, parseToJSON, pascal2Camel, pascal2Kebab, pascal2Snake, pascal2Title, replacer, reviver, snake2Camel, snake2Kebab, snake2Pascal, snake2Title, title2Camel, title2Kebab, title2Pascal, title2Snake };
+export { type MaybeArray, type NullOrUndefinable, type Nullable, type Numeric, type PageRes, type PageResData, type Res, type UnDef, type Undefinable, attachFmt, camel2Kebab, camel2Pascal, camel2Snake, camel2Title, checkImg, currencyFmt, dateDuration, dateFmt, filterObj, fixiOSInputAutoZoomIn, getBaseAttachUrl, getHostEnv, getVariableType, hideBankCard, hideCardNo, hideEmail, hideFirstName, hideHead, hideMiddle, hideName, hidePhone, hideSurname, hideTail, hideThird, inBrowser, isArrStr, isArray, isBlob, isBoolean, isDate, isDef, isEmail, isEmpty, isError, isFile, isFunction, isIdCard, isJSONStr, isMap, isNull, isNumber, isNumeric, isObject, isPhone, isPromise, isRegExp, isSet, isString, isSymbol, isTel, isURL, isUndefined, isValidArrRes, isValidFileType, isValidKey, isValidPageRes, isValidRes, isValidResCode, isWeakMap, isWeakSet, jClear, jDebug, jError, jGroup, jGroupC, jGroupE, jInfo, jLog, jTime, jTimeEnd, jWarn, kebab2Camel, kebab2Pascal, kebab2Snake, kebab2Title, nonASCII, parseToJSON, pascal2Camel, pascal2Kebab, pascal2Snake, pascal2Title, recoverFile, replacer, resUrl, reviver, setBaseAttachUrl, snake2Camel, snake2Kebab, snake2Pascal, snake2Title, title2Camel, title2Kebab, title2Pascal, title2Snake, toThousands, userAgent, waitTime };