xctc-utils 1.3.3 → 1.3.5

package/README.md

@@ -3,13 +3,20 @@
 #### 安装 npm i xctc-utils
 #### 项目中引入 import utils from "xctc-utils"
 
-
+#### 类型判断
+```
+utils.type.isFunction(val) // 是否是函数
+utils.type.isObject(val)   // 是否是对象 null 类型为对象，该方法已对null进行过滤
+utils.type.isDate(val)     // 是否是时间对象
+utils.type.isNumber(val)   // 是否是number类型
+utils.type.isString(val)   // 是否是字符串类型
+utils.type.isBoolean(val)  // 是否是boolean类型
+utils.type.isWindow(val)    // 是否在浏览器环境下运行
+```
 #### LocalStorage使用，存取值时数据已经过处理
 ```
-
 存储： utils.useLocalStorage(key,value)
 取值： utils.getLocalStorage(key)
-
 ```
 
 #### sessionStorage使用，存取值时数据已经过处理
@@ -18,6 +25,15 @@
 存储： utils.useSessionStorage(key,value)
 取值： utils.getSessionStorage(key)
 
+```
+#### 删除缓存
+```
+key:string 需要删除的缓存键
+isAll:boolean 为true时删除调用方法的所有缓存，否则只删除当前传入的 key 值
+如果 isAll 为 true 时，方法会优先执行缓存的clear函数， key 传任意值，
+删除临时缓存： utils.removeSessionStorage(key,isAll)
+删除永久缓存： utils.removeLocalStorage(key,isAll)
+
 ```
 
 #### 获取当前设备环境
@@ -31,13 +47,15 @@
 ```
 
 
-#### 加密解密方法
+#### crypto-js 加密解密方法
 ```
 word： 需要加密的数据，数据可是字符串，对象等
 key： 加密 密钥
 iv：  密钥偏移量
 对同一个数据进行加密、解密时，encrypt和decrypt的iv和key保持一致
-对数据进行加密
+对word进行CryptoJS.enc.Utf8.parse转义
+CryptoJS.AES.encrypt加密，加密模式：CBC ； padding： CryptoJS.pad.Pkcs7
+对数据进行加密  
 utils.encrypt(word:any,key:any,iv:any)
 // 对数据进行解密
 utils.decrypt(word:any,key:any,iv:any)

package/dist/format/index.d.ts

@@ -0,0 +1,2 @@
+export declare function makePhone(tel: string): void;
+export declare function formatMobile(mobile: string): string | undefined;

package/dist/format/index.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatMobile = exports.makePhone = void 0;
+// h5页面拨打电话
+function makePhone(tel) {
+    if (tel) {
+        window.location.href = "tel://".concat(tel);
+    }
+}
+exports.makePhone = makePhone;
+function formatMobile(mobile) {
+    if (!mobile)
+        return;
+    return mobile.replace(/(\d{3})\d{4}(\d{4})/, "$1****$2");
+}
+exports.formatMobile = formatMobile;

package/dist/index.js

@@ -40,5 +40,7 @@ var crypto = __importStar(require("./crypto"));
 var weixin = __importStar(require("./weixin"));
 var time = __importStar(require("./time"));
 var mobile = __importStar(require("./mobile"));
-var obj = __assign(__assign(__assign(__assign(__assign(__assign({}, storage), utils), weixin), crypto), time), mobile);
+var format = __importStar(require("./format"));
+var is = __importStar(require("./is"));
+var obj = __assign(__assign(__assign(__assign(__assign(__assign(__assign(__assign({}, storage), utils), weixin), crypto), time), mobile), format), { type: __assign({}, is) });
 exports.default = obj;

package/dist/is/index.d.ts

@@ -0,0 +1,36 @@
+/**
+ * @description: 判断传入的值是否为指定类型
+ */
+export declare function is(val: unknown, type: string): boolean;
+/**
+ * @description:  是否为函数
+ */
+export declare function isFunction<T = Function>(val: unknown): val is T;
+/**
+ * @description: 是否为对象
+ */
+export declare const isObject: (val: any) => val is Record<any, any>;
+/**
+ * @description:  是否为时间对象
+*/
+export declare function isDate(val: unknown): val is Date;
+/**
+ * @description:  是否为number类型
+ */
+export declare function isNumber(val: unknown): val is number;
+/**
+ * @description:  是否为字符串
+ */
+export declare function isString(val: unknown): val is string;
+/**
+ * @description:  是否为boolean类型
+ */
+export declare function isBoolean(val: unknown): val is boolean;
+/**
+ * @description:  是否为数组
+ */
+export declare function isArray(val: any): val is Array<any>;
+/**
+ * @description: 是否为浏览器
+ */
+export declare const isWindow: (val: any) => val is Window;

package/dist/is/index.js

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isWindow = exports.isArray = exports.isBoolean = exports.isString = exports.isNumber = exports.isDate = exports.isObject = exports.isFunction = exports.is = void 0;
+var toString = Object.prototype.toString;
+/**
+ * @description: 判断传入的值是否为指定类型
+ */
+function is(val, type) {
+    if (!type)
+        return false;
+    return toString.call(val) === "[object ".concat(type, "]");
+}
+exports.is = is;
+/**
+ * @description:  是否为函数
+ */
+function isFunction(val) {
+    if (!val)
+        return false;
+    return is(val, "Function");
+}
+exports.isFunction = isFunction;
+/**
+ * @description: 是否为对象
+ */
+var isObject = function (val) {
+    return val !== null && is(val, "Object");
+};
+exports.isObject = isObject;
+/**
+ * @description:  是否为时间对象
+*/
+function isDate(val) {
+    if (!val)
+        return false;
+    return is(val, "Date");
+}
+exports.isDate = isDate;
+/**
+ * @description:  是否为number类型
+ */
+function isNumber(val) {
+    return is(val, "Number");
+}
+exports.isNumber = isNumber;
+/**
+ * @description:  是否为字符串
+ */
+function isString(val) {
+    return is(val, "String");
+}
+exports.isString = isString;
+/**
+ * @description:  是否为boolean类型
+ */
+function isBoolean(val) {
+    return is(val, "Boolean");
+}
+exports.isBoolean = isBoolean;
+/**
+ * @description:  是否为数组
+ */
+function isArray(val) {
+    return val && Array.isArray(val);
+}
+exports.isArray = isArray;
+/**
+ * @description: 是否为浏览器
+ */
+var isWindow = function (val) {
+    return typeof window !== "undefined" && is(val, "Window");
+};
+exports.isWindow = isWindow;

package/dist/storage/index.d.ts

@@ -2,3 +2,5 @@ export declare function useLocalStorage(key: string, value: any): false | undefi
 export declare function getLocalStorage(key: string): any;
 export declare function useSessionStorage(key: string, value: any): false | undefined;
 export declare function getSessionStorage(key: string): any;
+export declare function removeSessionStorage(key?: string, isAll?: boolean): void;
+export declare function removeLocalStorage(key?: string, isAll?: boolean): void;

package/dist/storage/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getSessionStorage = exports.useSessionStorage = exports.getLocalStorage = exports.useLocalStorage = void 0;
+exports.removeLocalStorage = exports.removeSessionStorage = exports.getSessionStorage = exports.useSessionStorage = exports.getLocalStorage = exports.useLocalStorage = void 0;
+var is_1 = require("../is");
 var wls = window.localStorage;
 var wss = window.sessionStorage;
 var utils_1 = require("../utils");
@@ -50,3 +51,26 @@ function getStorage(key, obj) {
         val = data;
     return val;
 }
+function removeSessionStorage(key, isAll) {
+    if ((0, is_1.isBoolean)(isAll) && isAll) {
+        wss.clear();
+        return;
+    }
+    if (!key)
+        return;
+    removeStorage(key, wss);
+}
+exports.removeSessionStorage = removeSessionStorage;
+function removeLocalStorage(key, isAll) {
+    if ((0, is_1.isBoolean)(isAll) && isAll) {
+        wls.clear();
+        return;
+    }
+    if (!key)
+        return;
+    removeStorage(key, wls);
+}
+exports.removeLocalStorage = removeLocalStorage;
+function removeStorage(key, obj) {
+    obj.removeItem(key);
+}

package/dist/time/index.d.ts

@@ -11,4 +11,4 @@ export declare function formatTimeStamp(num?: number, format?: string): string;
  * @param str 字符串格式必须为： 2017/03/03 12:23:55 格式，避免兼容性，不能传 “ - ” 分割的时间字符串 2017-03-03
  * @returns
  */
-export declare function formatStrTime(str: string): number | undefined;
+export declare function formatStrTime(str: string): any;

package/dist/time/index.js

@@ -69,7 +69,7 @@ function isExist(str, key) {
  */
 function formatStrTime(str) {
     if (!str)
-        return;
+        return "";
     var timestamp = new Date(str).getTime();
     timestamp = timestamp / 1000;
     return parseInt(timestamp);

package/dist/weixin/index.js

@@ -12,20 +12,19 @@ var defaultKey = "5uMz4R8rop26DkC8";
 var defaultIv = "5uMz4Rsd0926DkC8";
 var weixinConfig = {};
 function weixinUrlCode(config) {
-    var _a, _b, _c, _d;
-    config = config !== null && config !== void 0 ? config : {};
-    var appId = (_a = config === null || config === void 0 ? void 0 : config.appId) !== null && _a !== void 0 ? _a : "";
+    config = config || {};
+    var appId = config['appId'] || "";
     if (!appId)
         return;
     weixinConfig = config;
-    var scope = (_b = config === null || config === void 0 ? void 0 : config.scope) !== null && _b !== void 0 ? _b : "snsapi_userinfo";
-    var codeKey = (_c = config === null || config === void 0 ? void 0 : config.codeKey) !== null && _c !== void 0 ? _c : "weixinCode";
-    var stateKey = (_d = config === null || config === void 0 ? void 0 : config.stateKey) !== null && _d !== void 0 ? _d : "weixinState";
+    var scope = config['scope'] || "snsapi_userinfo";
+    var codeKey = config['codeKey'] || "weixinCode";
+    var stateKey = config['stateKey'] || "weixinState";
     weixinConfig['scope'] = scope;
     weixinConfig['codeKey'] = codeKey;
     weixinConfig['stateKey'] = stateKey;
     (0, index_1.useSessionStorage)("weixinConfig", weixinConfig);
-    var _e = weixinConfig.cryptoiv, cryptoiv = _e === void 0 ? "" : _e, _f = weixinConfig.cryptokey, cryptokey = _f === void 0 ? "" : _f;
+    var _a = weixinConfig.cryptoiv, cryptoiv = _a === void 0 ? "" : _a, _b = weixinConfig.cryptokey, cryptokey = _b === void 0 ? "" : _b;
     var search = loc.search; // ?code=0916SzFa1KH9TA0Ke7Ha1AQx6446SzFr&state=123
     // 获取地址栏返回 code 参数
     var localCode = "";
@@ -119,14 +118,14 @@ function weixinLogin(code) {
         return;
     (0, index_1.useSessionStorage)("weixinLoginParams", JSON.stringify(obj));
     // 调试字段 isPassLogin ，为true 时不继续执行微信登录，前端可拿到 code 给后端测试
-    if (weixinConfig === null || weixinConfig === void 0 ? void 0 : weixinConfig.isPassLogin)
+    if (weixinConfig['isPassLogin'])
         return;
     weixinConfig.http(obj).then(function (res) {
         if (res.code == 40163) {
             // 未登录则先执行登录
             return weixinCode();
         }
-        var data = res === null || res === void 0 ? void 0 : res.data;
+        var data = res['data'] || {};
         for (var key in data) {
             var item = data[key];
             if (item instanceof Object) {
@@ -192,11 +191,13 @@ function weixinInit() {
     return wx;
 }
 function weixinCode() {
-    var _a;
     if ((0, utils_1.weixinBrowser)()) {
         if (!weixinConfig['appId'])
             return;
-        var scope = (_a = weixinConfig === null || weixinConfig === void 0 ? void 0 : weixinConfig.scope) !== null && _a !== void 0 ? _a : "snsapi_userinfo";
+        var scope = "snsapi_userinfo";
+        if (weixinConfig['scope']) {
+            scope = weixinConfig.scope;
+        }
         var base = "https://open.weixin.qq.com/connect/oauth2/authorize?";
         var uri = encodeURIComponent(loc.href.split("?")[0]);
         var config = "appid=".concat(weixinConfig.appId, "&redirect_uri=").concat(uri, "&response_type=code&scope=").concat(scope, "&state=state#wechat_redirect");
@@ -214,8 +215,7 @@ var defaultJsApiList = [
     "downloadImage", "translateVoice", "getNetworkType", "openLocation", "getLocation", "hideOptionMenu", "showOptionMenu", "hideMenuItems", "showMenuItems", "hideAllNonBaseMenuItem", "showAllNonBaseMenuItem",
 ];
 function weixinShareConfig(config) {
-    var _a;
-    if (!(config === null || config === void 0 ? void 0 : config.http))
+    if (!config['http'])
         return;
     var url = loc.href.split("#")[0];
     var param = {
@@ -223,12 +223,12 @@ function weixinShareConfig(config) {
         appId: config.appId,
     };
     var jsApiList = defaultJsApiList;
-    if ((_a = config === null || config === void 0 ? void 0 : config.jsApiList) === null || _a === void 0 ? void 0 : _a.length)
+    if (config && config.jsApiList && config.jsApiList.length) {
         jsApiList = config.jsApiList;
+    }
     config.http(param).then(function (res) {
-        var _a;
         if (res.code == 0) {
-            var data = (_a = res === null || res === void 0 ? void 0 : res.data) !== null && _a !== void 0 ? _a : {};
+            var data = res['data'] || {};
             var wx = weixinInit();
             wx.config({
                 debug: false,
@@ -241,7 +241,7 @@ function weixinShareConfig(config) {
             wx.ready(function (res) {
                 console.log("加载微信分享配置完成：", res);
                 (0, index_1.useSessionStorage)("weixinShareConfigSuccess", "\u52A0\u8F7D\u5FAE\u4FE1\u5206\u4EAB\u914D\u7F6E\u5B8C\u6210\uFF1A".concat(res));
-                if ((config === null || config === void 0 ? void 0 : config.cb) && typeof config.cb === "function")
+                if (config['cb'] && typeof config.cb === "function")
                     config.cb();
             });
             wx.error(function (err) {
@@ -252,23 +252,26 @@ function weixinShareConfig(config) {
 }
 exports.weixinShareConfig = weixinShareConfig;
 function weixinShareInit(options) {
-    var title = "微信分享";
-    if (options === null || options === void 0 ? void 0 : options.title)
+    var title = "微信分享标题";
+    if (options['title'])
         title = options.title;
     var desc = "微信分享描述";
-    if (options === null || options === void 0 ? void 0 : options.desc)
+    if (options['desc'])
         desc = options.desc;
     var link = loc.origin;
-    if (options === null || options === void 0 ? void 0 : options.link)
+    if (options['link'])
         link = options.link;
     var imgUrl = "";
-    if (options === null || options === void 0 ? void 0 : options.imgUrl)
+    if (options['imgUrl'])
         imgUrl = options.imgUrl;
     if (options && typeof options == "object") {
         var state = "";
-        if (options === null || options === void 0 ? void 0 : options.data) {
+        if (options['data']) {
             var data = options.data;
-            state = (0, crypto_1.encrypt)(data, cryptoConfig(options['key']).key, cryptoConfig(options['iv']).iv);
+            var key = options['key'] || defaultKey;
+            var iv = options['iv'] || defaultIv;
+            var cryptoObj = cryptoConfig(key, iv);
+            state = (0, crypto_1.encrypt)(data, cryptoObj.key, cryptoObj.iv);
             link = "".concat(link, "?state=").concat(state);
         }
     }
@@ -312,7 +315,7 @@ function weixinPay(config) {
     var wx = weixinInit();
     // let { timeStamp,signType,prepay_id,paySign,package,nonceStr,appId } = params
     var cb = "";
-    if ((config === null || config === void 0 ? void 0 : config.cb) && typeof config.cb === "function")
+    if (config['cb'] && typeof config.cb === "function")
         cb = config.cb;
     wx.chooseWXPay({
         timestamp: config.timeStamp,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xctc-utils",
-  "version": "1.3.3",
+  "version": "1.3.5",
   "description": "localStorage存储\r ```\r sessionStorage存储\r ```\r crypto-js加密、解密\r ```\r 微信授权登录、微信分享\r ```\r 设备环境获取\r ```\r 是否是微信浏览器\r ```\r 时间戳转时间，字符串转时间戳",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",