@jhqn/utils-core 0.0.1-beta.2 → 0.0.1-beta.20

package/dist/index.cjs

@@ -1,5 +1,7 @@
 'use strict';
 
+const detectBrowser = require('detect-browser');
+
 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());
 const snake2Camel = (str) => str.replace(/(_([a-z]))/g, (match) => match[1].toUpperCase());
@@ -83,6 +85,23 @@ const isTel = (val) => {
     return false;
   return cnTelRE.test(val.toString());
 };
+const isEmail = (val) => {
+  if (!isDef(val))
+    return false;
+  const reg = /^[a-zA-Z\d](?:\w|-)+@[a-zA-Z\d]+\.[a-zA-Z]{2,5}$/;
+  return reg.test(val);
+};
+const isIdCard = (val) => {
+  if (!isDef(val))
+    return false;
+  const card15 = /^[1-9]\d{7}(?:0[1-9]|10|11|12)(?:[0-2][1-9]|10|20|30|31)\d{2}[\dXx]$/;
+  const card18 = /^[1-9]\d{5}(?:18|19|20)\d{2}(?:0[1-9]|1[0-2])(?:[0-2][1-9]|10|20|30|31)\d{3}[\dXx]$/;
+  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 hidePhone = (str) => {
   if (str) {
@@ -138,6 +157,61 @@ const hideThird = (str) => {
   return str.slice(0, partLen) + "*".repeat(len - 2 * partLen) + str.slice(len - partLen);
 };
 
+const inBrowser = typeof window !== "undefined";
+const waitTime = (time = 100) => {
+  return new Promise((resolve) => {
+    setTimeout(() => {
+      resolve(true);
+    }, time);
+  });
+};
+const fixiOSInputAutoZoomIn = () => {
+  if (CSS.supports("(font:-apple-system-body) and (-webkit-touch-callout:none) and (-webkit-tap-highlight-color:hotpink)")) {
+    const viewport = document.querySelector('meta[name="viewport"]');
+    if (viewport !== null) {
+      viewport.content = `${viewport.content}, user-scalable=no`;
+    }
+  }
+};
+const userAgent = inBrowser ? window.navigator.userAgent : "";
+const getHostEnv = () => {
+  const ua = userAgent.toLowerCase();
+  const baseInfo = detectBrowser.detect();
+  const zlb = ua.includes("@zlb");
+  const zyd = ua.includes("saas");
+  const zzd = ua.includes("zhejiang") || ua.includes("tauruszjd");
+  const wx = ua.includes("micromessenger");
+  const zfb = ua.includes("alipay");
+  const mini = ua.includes("miniprogram");
+  return {
+    ...baseInfo,
+    /**
+     * 是否是浙里办
+     */
+    zlb,
+    /**
+     * 是否是专有钉
+     */
+    zyd,
+    /**
+     * 是否是浙政钉
+     */
+    zzd,
+    /**
+     * 是否是微信
+     */
+    wx,
+    /**
+     * 是否是支付宝
+     */
+    zfb,
+    /**
+     * 是否是小程序
+     */
+    mini
+  };
+};
+
 const parseToJSON = (str, reviver2) => isJSONStr(str) ? JSON.parse(str, reviver2) : null;
 const replacer = (_, value) => {
   if (value instanceof Map) {
@@ -164,18 +238,26 @@ exports.camel2Snake = camel2Snake;
 exports.camel2Title = camel2Title;
 exports.checkImg = checkImg;
 exports.filterObj = filterObj;
+exports.fixiOSInputAutoZoomIn = fixiOSInputAutoZoomIn;
+exports.getHostEnv = getHostEnv;
 exports.hideCardNo = hideCardNo;
 exports.hideMiddle = hideMiddle;
 exports.hideName = hideName;
 exports.hidePhone = hidePhone;
 exports.hideThird = hideThird;
+exports.inBrowser = inBrowser;
 exports.isArrStr = isArrStr;
 exports.isDef = isDef;
+exports.isEmail = isEmail;
+exports.isIdCard = isIdCard;
 exports.isJSONStr = isJSONStr;
 exports.isNumeric = isNumeric;
 exports.isPhone = isPhone;
 exports.isTel = isTel;
+exports.isValidArrRes = isValidArrRes;
 exports.isValidKey = isValidKey;
+exports.isValidPageRes = isValidPageRes;
+exports.isValidRes = isValidRes;
 exports.jClear = jClear;
 exports.jDebug = jDebug;
 exports.jError = jError;
@@ -191,6 +273,7 @@ exports.kebab2Camel = kebab2Camel;
 exports.kebab2Pascal = kebab2Pascal;
 exports.kebab2Snake = kebab2Snake;
 exports.kebab2Title = kebab2Title;
+exports.nonASCII = nonASCII;
 exports.parseToJSON = parseToJSON;
 exports.pascal2Camel = pascal2Camel;
 exports.pascal2Kebab = pascal2Kebab;
@@ -206,3 +289,5 @@ exports.title2Camel = title2Camel;
 exports.title2Kebab = title2Kebab;
 exports.title2Pascal = title2Pascal;
 exports.title2Snake = title2Snake;
+exports.userAgent = userAgent;
+exports.waitTime = waitTime;

package/dist/index.d.ts

@@ -1,3 +1,5 @@
+import * as detect_browser from 'detect-browser';
+
 /**
  * snake2Kebab
  * @param {string} str 字符串
@@ -212,6 +214,18 @@ declare type Undefinable<T> = T | undefined;
  * 可 Null 或 Undefined
  */
 declare type NullOrUndefinable<T> = Nullable<Undefinable<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>;
 
 /**
  * 隐藏手机号
@@ -239,12 +253,208 @@ declare const hideMiddle: (str: NullOrUndefinable<string>) => string;
  */
 declare const hideThird: (str: NullOrUndefinable<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 _
@@ -292,6 +502,18 @@ declare const isJSONStr: (str: string) => boolean;
  * @param str
  */
 declare const isArrStr: (str: 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;
 /**
  * 是否是中国手机号
@@ -303,5 +525,35 @@ declare const isPhone: (val: NullOrUndefinable<Numeric>) => boolean;
  * @param val
  */
 declare const isTel: (val: NullOrUndefinable<Numeric>) => boolean;
+/**
+ * 是否是邮箱
+ * @param val
+ */
+declare const isEmail: (val: NullOrUndefinable<string>) => boolean;
+/**
+ * 是否是身份证
+ * @param val 身份证号
+ */
+declare const isIdCard: (val: NullOrUndefinable<string>) => boolean;
+/**
+ * 包含非ASCII字符
+ * @param text
+ */
+declare const nonASCII: (text: string) => boolean;
+/**
+ * 校验接口返回内容
+ * @param res
+ */
+declare const isValidRes: (res: Res) => boolean;
+/**
+ * 校验接口数组返回内容
+ * @param res
+ */
+declare const isValidArrRes: (res: Res<any[]>) => boolean;
+/**
+ * 校验接口分页返回内容
+ * @param res
+ */
+declare const isValidPageRes: (res: PageRes) => 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 { NullOrUndefinable, Nullable, Numeric, PageRes, PageResData, Res, Undefinable, camel2Kebab, camel2Pascal, camel2Snake, camel2Title, checkImg, 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 };

package/dist/index.mjs

@@ -1,3 +1,5 @@
+import { detect } from 'detect-browser';
+
 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());
 const snake2Camel = (str) => str.replace(/(_([a-z]))/g, (match) => match[1].toUpperCase());
@@ -81,6 +83,23 @@ const isTel = (val) => {
     return false;
   return cnTelRE.test(val.toString());
 };
+const isEmail = (val) => {
+  if (!isDef(val))
+    return false;
+  const reg = /^[a-zA-Z\d](?:\w|-)+@[a-zA-Z\d]+\.[a-zA-Z]{2,5}$/;
+  return reg.test(val);
+};
+const isIdCard = (val) => {
+  if (!isDef(val))
+    return false;
+  const card15 = /^[1-9]\d{7}(?:0[1-9]|10|11|12)(?:[0-2][1-9]|10|20|30|31)\d{2}[\dXx]$/;
+  const card18 = /^[1-9]\d{5}(?:18|19|20)\d{2}(?:0[1-9]|1[0-2])(?:[0-2][1-9]|10|20|30|31)\d{3}[\dXx]$/;
+  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 hidePhone = (str) => {
   if (str) {
@@ -136,6 +155,61 @@ const hideThird = (str) => {
   return str.slice(0, partLen) + "*".repeat(len - 2 * partLen) + str.slice(len - partLen);
 };
 
+const inBrowser = typeof window !== "undefined";
+const waitTime = (time = 100) => {
+  return new Promise((resolve) => {
+    setTimeout(() => {
+      resolve(true);
+    }, time);
+  });
+};
+const fixiOSInputAutoZoomIn = () => {
+  if (CSS.supports("(font:-apple-system-body) and (-webkit-touch-callout:none) and (-webkit-tap-highlight-color:hotpink)")) {
+    const viewport = document.querySelector('meta[name="viewport"]');
+    if (viewport !== null) {
+      viewport.content = `${viewport.content}, user-scalable=no`;
+    }
+  }
+};
+const userAgent = inBrowser ? window.navigator.userAgent : "";
+const getHostEnv = () => {
+  const ua = userAgent.toLowerCase();
+  const baseInfo = detect();
+  const zlb = ua.includes("@zlb");
+  const zyd = ua.includes("saas");
+  const zzd = ua.includes("zhejiang") || ua.includes("tauruszjd");
+  const wx = ua.includes("micromessenger");
+  const zfb = ua.includes("alipay");
+  const mini = ua.includes("miniprogram");
+  return {
+    ...baseInfo,
+    /**
+     * 是否是浙里办
+     */
+    zlb,
+    /**
+     * 是否是专有钉
+     */
+    zyd,
+    /**
+     * 是否是浙政钉
+     */
+    zzd,
+    /**
+     * 是否是微信
+     */
+    wx,
+    /**
+     * 是否是支付宝
+     */
+    zfb,
+    /**
+     * 是否是小程序
+     */
+    mini
+  };
+};
+
 const parseToJSON = (str, reviver2) => isJSONStr(str) ? JSON.parse(str, reviver2) : null;
 const replacer = (_, value) => {
   if (value instanceof Map) {
@@ -156,4 +230,4 @@ const reviver = (_, value) => {
 };
 const filterObj = (obj, keys, reverse = false) => Object.fromEntries(Object.entries(obj).filter(([key]) => reverse ? !keys.includes(key) : keys.includes(key)));
 
-export { 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 { camel2Kebab, camel2Pascal, camel2Snake, camel2Title, checkImg, 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 };

package/package.json

@@ -1,11 +1,9 @@
 {
   "name": "@jhqn/utils-core",
+  "type": "module",
+  "version": "0.0.1-beta.20",
   "author": "jade-gjz <jiangang.zhang@jaderd.com>",
-  "version": "0.0.1-beta.2",
-  "keywords": [
-    "jade",
-    "utils"
-  ],
+  "license": "MIT",
   "homepage": "https://github.com/jaderd-jh/utils/tree/main/packages/core#readme",
   "repository": {
     "type": "git",
@@ -15,24 +13,31 @@
   "bugs": {
     "url": "https://github.com/jaderd-jh/utils/issues"
   },
-  "type": "module",
-  "files": [
-    "dist"
+  "keywords": [
+    "jade",
+    "utils"
   ],
-  "main": "dist/index.cjs",
-  "module": "dist/index.mjs",
-  "types": "dist/index.d.ts",
+  "sideEffects": false,
   "exports": {
     ".": {
+      "types": "./dist/index.d.ts",
       "import": "./dist/index.mjs",
-      "require": "./dist/index.cjs",
-      "types": "./dist/index.d.ts"
+      "require": "./dist/index.cjs"
     }
   },
-  "sideEffects": false,
+  "main": "dist/index.cjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "detect-browser": "^5.3.0"
+  },
   "scripts": {
     "test": "vitest",
     "//build": "tsup",
-    "build": "unbuild"
+    "build": "unbuild",
+    "publint": "publint"
   }
 }