@jhqn/utils-core 0.0.1-beta.22 → 0.0.1-beta.24

package/dist/index.d.ts

@@ -1,11 +1,11 @@
-/// <reference types="dayjs/esm/plugin/localeData" />
-/// <reference types="dayjs/esm/plugin/duration" />
-/// <reference types="dayjs/esm/plugin/relativeTime" />
-/// <reference types="dayjs/esm/plugin/customParseFormat" />
-/// <reference types="dayjs/esm/plugin/objectSupport" />
+/// <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/esm';
-export { Dayjs, default as dayjs } from 'dayjs/esm';
+import { ConfigType } from 'dayjs';
+export { Dayjs, default as dayjs } from 'dayjs';
 
 /**
  * snake2Kebab
@@ -233,32 +233,62 @@ 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: NullOrUndefinable<string>) => string;
+/**
+ * 隐藏首尾仅保留中间3分之1
+ * @param {string} str 需要隐藏的字符串
+ */
+declare const hideThird: (str: NullOrUndefinable<string>) => string;
+/**
+ * 隐藏首部
+ * @param {string} str 需要隐藏的字符串
+ */
+declare const hideHead: (str: NullOrUndefinable<string>) => string;
+/**
+ * 隐藏尾部
+ * @param {string} str 需要隐藏的字符串
+ */
+declare const hideTail: (str: NullOrUndefinable<string>) => string;
 /**
  * 隐藏手机号
- * @param str
+ * @param {string} phone 手机号
  */
-declare const hidePhone: (str: NullOrUndefinable<string>) => string;
+declare const hidePhone: (phone: NullOrUndefinable<string>) => string;
 /**
  * 隐藏身份证号
- * @param cardNo
+ * @param {string} cardNo 身份证号
  */
 declare const hideCardNo: (cardNo: NullOrUndefinable<string>) => string;
 /**
- * 隐藏姓名
- * @param name
+ * 隐藏姓名第一个字
+ * @param {string} name 姓名
+ * @deprecated 请使用 hideSurname
  */
 declare const hideName: (name: NullOrUndefinable<string>) => string;
 /**
- * 隐藏中间部分
- * @param str
+ * 隐藏姓氏
+ * @param {string} name 姓名
  */
-declare const hideMiddle: (str: NullOrUndefinable<string>) => string;
+declare const hideSurname: (name: NullOrUndefinable<string>) => string;
 /**
- * 隐藏首尾仅保留中间3分之1
- * @param str
+ * 隐藏名字
+ * @param {string} name 姓名
  */
-declare const hideThird: (str: NullOrUndefinable<string>) => string;
+declare const hideFirstName: (name: NullOrUndefinable<string>) => string;
+/**
+ * 隐藏邮箱
+ * @param {string} email 邮箱
+ */
+declare const hideEmail: (email: NullOrUndefinable<string>) => string;
 
 /**
  * 判断是否是浏览器环境
@@ -486,18 +516,125 @@ declare const filterObj: (obj: Record<string, any>, keys: string[], reverse?: bo
 
 /**
  * 格式化时间
- * @param {import('dayjs/esm').ConfigType} date 时间
+ * @param {import('dayjs').ConfigType} date 时间
  * @param {string} format 格式
  * @returns {string} 格式化后的时间
  */
 declare const dateFmt: (date: ConfigType, format?: string | 'date' | 'datetime') => string;
 /**
  * 格式化时间间隔
- * @param {import('dayjs/esm').ConfigType} start 开始时间
- * @param {import('dayjs/esm').ConfigType} end 结束时间
+ * @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 currency
+ * @param fraction
+ */
+declare const currencyFmt: (currency: NullOrUndefinable<number | bigint>, fraction?: 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;
+    percentage?: number | undefined;
+};
+/**
+ * 附件格式
+ * @param data
+ */
+declare const attachFmt: (data: NullOrUndefinable<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;
+    percentage?: number | undefined;
+}[];
+
 /**
  * 是否有意义的值
  * @param val
@@ -513,6 +650,11 @@ declare const isNumeric: (val: Numeric) => val is string;
  * @param ext
  */
 declare const checkImg: (ext?: string) => boolean;
+/**
+ * 是否是空值/空数组/空对象 null undefined '' [] {} Set Map
+ * @param val
+ */
+declare const isEmpty: (val: NullOrUndefinable<Numeric | boolean | Record<any, any> | Array<any> | Set<any> | Map<any, any>>) => boolean;
 /**
  * 判断是否合法JSON字符串
  * @param str
@@ -561,20 +703,36 @@ declare const isIdCard: (val: NullOrUndefinable<string>) => boolean;
  * @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) => boolean;
+declare const isValidRes: (res: Res, code?: number) => boolean;
 /**
  * 校验接口数组返回内容
  * @param res
+ * @param code
  */
-declare const isValidArrRes: (res: Res<any[]>) => boolean;
+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 isValidPageRes: (res: PageRes) => boolean;
+declare const isValidFileType: (file: File, type: string) => boolean;
 
-export { NullOrUndefinable, Nullable, Numeric, PageRes, PageResData, Res, Undefinable, camel2Kebab, camel2Pascal, camel2Snake, camel2Title, checkImg, dateDuration, dateFmt, filterObj, fixiOSInputAutoZoomIn, getHostEnv, hideCardNo, hideMiddle, hideName, hidePhone, hideThird, inBrowser, isArrStr, isDef, isEmail, isIdCard, isJSONStr, isNumeric, isPhone, isTel, isValidArrRes, isValidKey, isValidPageRes, isValidRes, jClear, jDebug, jError, jGroup, jGroupC, jGroupE, jInfo, jLog, jTime, jTimeEnd, jWarn, kebab2Camel, kebab2Pascal, kebab2Snake, kebab2Title, nonASCII, parseToJSON, pascal2Camel, pascal2Kebab, pascal2Snake, pascal2Title, replacer, reviver, snake2Camel, snake2Kebab, snake2Pascal, snake2Title, title2Camel, title2Kebab, title2Pascal, title2Snake, userAgent, waitTime };
+export { type NullOrUndefinable, type Nullable, type Numeric, type PageRes, type PageResData, type Res, type Undefinable, attachFmt, camel2Kebab, camel2Pascal, camel2Snake, camel2Title, checkImg, currencyFmt, dateDuration, dateFmt, filterObj, fixiOSInputAutoZoomIn, getBaseAttachUrl, getHostEnv, hideCardNo, hideEmail, hideFirstName, hideHead, hideMiddle, hideName, hidePhone, hideSurname, hideTail, hideThird, inBrowser, isArrStr, isDef, isEmail, isEmpty, isIdCard, isJSONStr, isNumeric, isPhone, isTel, isValidArrRes, isValidFileType, isValidKey, isValidPageRes, isValidRes, isValidResCode, 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 };

package/dist/index.mjs

@@ -1,12 +1,12 @@
 import { detect } from 'detect-browser';
-import dayjs from 'dayjs/esm';
-export { default as dayjs } from 'dayjs/esm';
-import localeData from 'dayjs/esm/plugin/localeData';
-import duration from 'dayjs/esm/plugin/duration';
-import relativeTime from 'dayjs/esm/plugin/relativeTime';
-import customParseFormat from 'dayjs/esm/plugin/customParseFormat';
-import objectSupport from 'dayjs/esm/plugin/objectSupport';
-import zhCN from 'dayjs/esm/locale/zh-cn';
+import dayjs from 'dayjs';
+export { default as dayjs } from 'dayjs';
+import localeData from 'dayjs/plugin/localeData';
+import duration from 'dayjs/plugin/duration';
+import relativeTime from 'dayjs/plugin/relativeTime';
+import customParseFormat from 'dayjs/plugin/customParseFormat';
+import objectSupport from 'dayjs/plugin/objectSupport';
+import zhCN from 'dayjs/locale/zh-cn';
 
 const snake2Kebab = (str) => str.replace(/_([a-z])/g, (_, letter) => `-${letter.toLowerCase()}`);
 const snake2Pascal = (str) => str.replace(/_([a-z])/g, (_, letter) => letter.toUpperCase()).replace(/^[a-z]/, (letter) => letter.toUpperCase());
@@ -65,6 +65,9 @@ const isNumeric = (val) => typeof val === "number" || /^\d+(?:\.\d+)?$/.test(val
 const checkImg = (ext) => {
   return /\.(?:jpg|jpeg|png|gif)$/.test((ext || "").toLowerCase());
 };
+const isEmpty = (val) => {
+  return !isDef(val) || val === "" || Array.isArray(val) && val.length === 0 || Object.prototype.toString.call(val) === "[object Object]" && Object.keys(val).length === 0 || val instanceof Map && val.size === 0 || val instanceof Set && val.size === 0;
+};
 const isJSONStr = (str) => {
   try {
     JSON.parse(str);
@@ -105,19 +108,80 @@ const isIdCard = (val) => {
   return card15.test(val) || card18.test(val);
 };
 const nonASCII = (text) => /[^\x20-\x7E]/.test(text);
-const isValidRes = (res) => res.code === 200 && isDef(res.data);
-const isValidArrRes = (res) => res.code === 200 && Array.isArray(res.data);
-const isValidPageRes = (res) => res.code === 200 && isDef(res.data) && Array.isArray(res.data.list || res.data.records);
+const isValidResCode = (res, code = 200) => res.code === code;
+const isValidRes = (res, code) => isValidResCode(res, code) && isDef(res.data);
+const isValidArrRes = (res, code) => isValidResCode(res, code) && Array.isArray(res.data);
+const isValidPageRes = (res, code) => isValidResCode(res, code) && isDef(res.data) && Array.isArray(res.data.list || res.data.records);
+const isValidFileType = (file, type) => {
+  if (type === "*")
+    return true;
+  const fileType = file.type;
+  const fileName = file.name;
+  function validate(item) {
+    if (item.startsWith(".")) {
+      return fileName.endsWith(item);
+    }
+    if (item.endsWith("/*")) {
+      return fileType.startsWith(item.replace("/*", ""));
+    }
+    if (item.includes("/")) {
+      return fileType === item;
+    }
+    return false;
+  }
+  const typeArrStr = type.split(",").map((item) => item.trim());
+  if (typeArrStr.length > 1) {
+    return typeArrStr.some(validate);
+  }
+  return validate(type);
+};
 
-const hidePhone = (str) => {
-  if (str) {
-    if (isPhone(str)) {
-      return str.replace(/^(\d{3})\d{4}(\d{4})$/, "$1****$2");
+const hideMiddle = (str) => {
+  if (!isDef(str))
+    return "";
+  const len = str.length;
+  if (len === 1)
+    return "*";
+  if (len === 2)
+    return "**";
+  return str[0] + "*".repeat(len - 2) + str[len - 1];
+};
+const hideThird = (str) => {
+  if (!isDef(str))
+    return "";
+  const len = str.length;
+  const partLen = Math.round(len / 3);
+  if (len === 1)
+    return "*";
+  if (len === 2)
+    return "**";
+  return str.slice(0, partLen) + "*".repeat(len - 2 * partLen) + str.slice(len - partLen);
+};
+const hideHead = (str) => {
+  if (!isDef(str))
+    return "";
+  const len = str.length;
+  if (len === 1)
+    return "*";
+  return "*".repeat(len - 1) + str[len - 1];
+};
+const hideTail = (str) => {
+  if (!isDef(str))
+    return "";
+  const len = str.length;
+  if (len === 1)
+    return "*";
+  return str[0] + "*".repeat(len - 1);
+};
+const hidePhone = (phone) => {
+  if (phone) {
+    if (isPhone(phone)) {
+      return phone.replace(/^(\d{3})\d{4}(\d{4})$/, "$1****$2");
     }
-    if (isTel(str)) {
-      return str.replace(/^(\d{3,4})-?\d{3,4}(\d{4})$/, "$1****$2");
+    if (isTel(phone)) {
+      return phone.replace(/^(\d{3,4})-?\d{3,4}(\d{4})$/, "$1****$2");
     }
-    return str;
+    return phone;
   }
   return "";
 };
@@ -141,26 +205,25 @@ const hideName = (name) => {
   }
   return "";
 };
-const hideMiddle = (str) => {
-  if (!isDef(str))
-    return "";
-  const len = str.length;
-  if (len === 1)
-    return "*";
-  if (len === 2)
-    return "**";
-  return str[0] + "*".repeat(len - 2) + str[len - 1];
+const hideSurname = (name) => {
+  return hideHead(name);
 };
-const hideThird = (str) => {
-  if (!isDef(str))
-    return "";
-  const len = str.length;
-  const partLen = Math.round(len / 3);
-  if (len === 1)
-    return "*";
-  if (len === 2)
-    return "**";
-  return str.slice(0, partLen) + "*".repeat(len - 2 * partLen) + str.slice(len - partLen);
+const hideFirstName = (name) => {
+  return hideTail(name);
+};
+const hideEmail = (email) => {
+  if (email) {
+    if (!email.includes("@"))
+      return "";
+    const arr = email.split("@");
+    const name = arr[0];
+    const domain = arr[1];
+    const len = name?.length;
+    if (!len)
+      return email;
+    return `${hideTail(name)}@${domain}`;
+  }
+  return "";
 };
 
 const inBrowser = typeof window !== "undefined";
@@ -271,4 +334,77 @@ const dateDuration = (start, end) => {
   return dd.format(format);
 };
 
-export { camel2Kebab, camel2Pascal, camel2Snake, camel2Title, checkImg, dateDuration, dateFmt, filterObj, fixiOSInputAutoZoomIn, getHostEnv, hideCardNo, hideMiddle, hideName, hidePhone, hideThird, inBrowser, isArrStr, isDef, isEmail, isIdCard, isJSONStr, isNumeric, isPhone, isTel, isValidArrRes, isValidKey, isValidPageRes, isValidRes, jClear, jDebug, jError, jGroup, jGroupC, jGroupE, jInfo, jLog, jTime, jTimeEnd, jWarn, kebab2Camel, kebab2Pascal, kebab2Snake, kebab2Title, nonASCII, parseToJSON, pascal2Camel, pascal2Kebab, pascal2Snake, pascal2Title, replacer, reviver, snake2Camel, snake2Kebab, snake2Pascal, snake2Title, title2Camel, title2Kebab, title2Pascal, title2Snake, userAgent, waitTime };
+let BASE_ATTACH_URL;
+function setBaseAttachUrl(baseUrl) {
+  BASE_ATTACH_URL = baseUrl;
+}
+function getBaseAttachUrl() {
+  return BASE_ATTACH_URL;
+}
+if (import.meta.env?.VITE_BASE_ATTACH_URL) {
+  setBaseAttachUrl(import.meta.env.VITE_BASE_ATTACH_URL);
+}
+
+const toThousands = (num) => {
+  const arr = num.toString().split(".");
+  const integer = arr[0]?.replace(/(\d)(?=(?:\d{3})+$)/g, "$1,");
+  if (arr.length > 1)
+    return `${integer}.${arr[1]}`;
+  return integer;
+};
+const currencyFmt = (currency, fraction = 0) => {
+  if (!isDef(currency))
+    return "";
+  return new Intl.NumberFormat("zh-CN", { style: "currency", currency: "CNY", maximumFractionDigits: fraction }).format(
+    currency
+  );
+};
+
+const resUrl = (url) => {
+  if (!isDef(url))
+    return void 0;
+  if (/^https?:\/\//.test(url) || /^blob:/.test(url) || /^data:/.test(url)) {
+    return url;
+  }
+  const baseUrl = getBaseAttachUrl();
+  if (!isDef(baseUrl)) {
+    throw new Error("\u8BF7\u5148\u8BBE\u7F6E import.meta\u200B.env.VITE_BASE_ATTACH_URL");
+  }
+  return `${baseUrl}/${url}`.replace(/([^:]\/)\/+/g, "$1");
+};
+const recoverFile = (resource) => {
+  const { uri, url, ...item } = resource;
+  const validUrl = uri || url;
+  return {
+    ...item,
+    url: resUrl(validUrl),
+    content: resUrl(validUrl),
+    uri: validUrl || "",
+    status: "done",
+    percent: 100
+  };
+};
+const attachFmt = (data) => {
+  let attachList = [];
+  const prototype = Object.prototype.toString.call(data);
+  if (!data)
+    attachList = [];
+  else if (Array.isArray(data))
+    attachList = data.filter(Boolean);
+  else if (typeof data === "string") {
+    if (isArrStr(data)) {
+      attachList = (parseToJSON(data) || []).filter(Boolean);
+    } else {
+      const jsonData = parseToJSON(data);
+      const prototypeJson = Object.prototype.toString.call(jsonData);
+      if (prototypeJson === "[object Object]")
+        attachList = [jsonData].filter(Boolean);
+      else
+        attachList = [{ id: data, name: "name", uri: data, group: "default" }];
+    }
+  } else if (prototype === "[object Object]")
+    attachList = [data];
+  return attachList.map(recoverFile);
+};
+
+export { attachFmt, camel2Kebab, camel2Pascal, camel2Snake, camel2Title, checkImg, currencyFmt, dateDuration, dateFmt, filterObj, fixiOSInputAutoZoomIn, getBaseAttachUrl, getHostEnv, hideCardNo, hideEmail, hideFirstName, hideHead, hideMiddle, hideName, hidePhone, hideSurname, hideTail, hideThird, inBrowser, isArrStr, isDef, isEmail, isEmpty, isIdCard, isJSONStr, isNumeric, isPhone, isTel, isValidArrRes, isValidFileType, isValidKey, isValidPageRes, isValidRes, isValidResCode, 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 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@jhqn/utils-core",
   "type": "module",
-  "version": "0.0.1-beta.22",
+  "version": "0.0.1-beta.24",
   "author": "jade-gjz <jiangang.zhang@jaderd.com>",
   "license": "MIT",
   "homepage": "https://github.com/jaderd-jh/utils/tree/main/packages/core#readme",
@@ -20,9 +20,14 @@
   "sideEffects": false,
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.mjs",
-      "require": "./dist/index.cjs"
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
     }
   },
   "main": "dist/index.cjs",
@@ -37,7 +42,6 @@
   },
   "scripts": {
     "test": "vitest",
-    "//build": "tsup",
     "build": "unbuild",
     "publint": "publint"
   }