mazey 3.6.7 → 3.7.0

package/README.md

@@ -59,48 +59,48 @@ There ara some examples maintained by hand below. For more information, please c
 
 **Table of Contents**
 
-<!-- toc - begin -->
-- Generated with ❤️
-- [Load Resource](#load-resource)
-  * [loadScript](#loadscript)
-  * [loadCSS](#loadcss)
-  * [windowLoaded](#windowloaded)
-- [Util](#util)
-  * [isNumber](#isnumber)
-  * [isJSONString](#isjsonstring)
-  * [isValidData](#isvaliddata)
-  * [generateRndNum](#generaterndnum)
-  * [formatDate](#formatdate)
-  * [debounce](#debounce)
-  * [throttle](#throttle)
-  * [convertCamelToKebab](#convertcameltokebab)
-  * [convertCamelToUnder](#convertcameltounder)
-  * [deepCopyObject](#deepcopyobject)
-  * [mTrim](#mtrim)
-- [URL](#url)
-  * [getQueryParam](#getqueryparam)
-  * [getUrlParam](#geturlparam)
-  * [getHashQueryParam](#gethashqueryparam)
-  * [getDomain](#getdomain)
-  * [updateQueryParam](#updatequeryparam)
-- [Cache Data](#cache-data)
-  * [Cookie](#cookie)
-  * [Storage](#storage)
-- [DOM](#dom)
-  * [addStyle](#addstyle)
-  * [Class](#class)
-  * [newLine](#newline)
-- [Calculate and Formula](#calculate-and-formula)
-  * [inRate](#inrate)
-  * [calLongestCommonSubstring](#callongestcommonsubstring)
-  * [calLongestCommonSubsequence](#callongestcommonsubsequence)
-- [Browser Information](#browser-information)
-  * [getBrowserInfo](#getbrowserinfo)
-  * [isSafePWAEnv](#issafepwaenv)
-- [Web Performance](#web-performance)
-  * [getPerformance](#getperformance)
-- [Debug](#debug)
-  * [genCustomConsole](#gencustomconsole)
+<!-- toc - begin -->
+- Generated with ❤️
+- [Load Resource](#load-resource)
+  * [loadScript](#loadscript)
+  * [loadCSS](#loadcss)
+  * [windowLoaded](#windowloaded)
+- [Util](#util)
+  * [isNumber](#isnumber)
+  * [isJSONString](#isjsonstring)
+  * [isValidData](#isvaliddata)
+  * [generateRndNum](#generaterndnum)
+  * [formatDate](#formatdate)
+  * [debounce](#debounce)
+  * [throttle](#throttle)
+  * [convertCamelToKebab](#convertcameltokebab)
+  * [convertCamelToUnder](#convertcameltounder)
+  * [deepCopyObject](#deepcopyobject)
+  * [mTrim](#mtrim)
+- [URL](#url)
+  * [getQueryParam](#getqueryparam)
+  * [getUrlParam](#geturlparam)
+  * [getHashQueryParam](#gethashqueryparam)
+  * [getDomain](#getdomain)
+  * [updateQueryParam](#updatequeryparam)
+- [Cache Data](#cache-data)
+  * [Cookie](#cookie)
+  * [Storage](#storage)
+- [DOM](#dom)
+  * [addStyle](#addstyle)
+  * [Class](#class)
+  * [newLine](#newline)
+- [Calculate and Formula](#calculate-and-formula)
+  * [inRate](#inrate)
+  * [calLongestCommonSubstring](#callongestcommonsubstring)
+  * [calLongestCommonSubsequence](#callongestcommonsubsequence)
+- [Browser Information](#browser-information)
+  * [getBrowserInfo](#getbrowserinfo)
+  * [isSafePWAEnv](#issafepwaenv)
+- [Web Performance](#web-performance)
+  * [getPerformance](#getperformance)
+- [Debug](#debug)
+  * [genCustomConsole](#gencustomconsole)
 <!-- toc - end -->
 
 ### Load Resource
@@ -424,16 +424,16 @@ getQueryParam('t4'); // 4
 
 #### getUrlParam
 
-Get the query param's value of the input URL.
+Returns the value of the specified query parameter in the input URL.
 
 ```
-getUrlParam('http://example.com/?t1=1&t2=2&t3=3&t4=4', 't3'); // 3
-getUrlParam('http://example.com/?t1=1&t2=2&t3=3&t4=4', 't4'); // 4
+getUrlParam('http://example.com/?t1=1&t2=2&t3=3&t4=4', 't3'); // Returns '3'
+getUrlParam('http://example.com/?t1=1&t2=2&t3=3&t4=4', 't4'); // Returns '4'
 ```
 
-<!-- @param {string} url URL string.
-@param {string} param Query param.
-@returns {string} value
+<!-- @param {string} url The URL string.
+@param {string} param The query parameter to retrieve the value for.
+@returns {string|string[]} The value of the specified query parameter, or an empty string if the parameter is not found.
 @category URL -->
 
 #### getHashQueryParam
@@ -553,7 +553,7 @@ function mGetLocalStorage (key) {
 ```
 
 <!-- @param {string} key 键
-@returns {any} 返回值
+@returns {void} 返回值
 @category Cache Data -->
 
 ### DOM

package/lib/index.cjs.js

@@ -1,5 +1,5 @@
 /*!
- * mazey v3.6.7
+ * mazey v3.7.0
  * (c) 2018-2023 Mazey Chu
  * Released under the MIT License.
  */
@@ -4362,34 +4362,32 @@ function getQueryParam(param) {
   return '';
 }
 /**
- * Get the query param's value of the input URL.
+ * Returns the value of the specified query parameter in the input URL.
  *
+ * @example
  * ```
- * getUrlParam('http://example.com/?t1=1&t2=2&t3=3&t4=4', 't3'); // 3
- * getUrlParam('http://example.com/?t1=1&t2=2&t3=3&t4=4', 't4'); // 4
+ * getUrlParam('http://example.com/?t1=1&t2=2&t3=3&t4=4', 't3'); // Returns '3'
+ * getUrlParam('http://example.com/?t1=1&t2=2&t3=3&t4=4', 't4'); // Returns '4'
  * ```
  *
- * @param {string} url URL string.
- * @param {string} param Query param.
- * @returns {string} value
+ * @param {string} url The URL string.
+ * @param {string} param The query parameter to retrieve the value for.
+ * @returns {string|string[]} The value of the specified query parameter, or an empty string if the parameter is not found.
  * @category URL
  */
 function getUrlParam(url, param) {
   var result = {};
-  // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/replace
-  url.replace(/\??(\w+)=([^&]*)&?/g, function (a, k, v) {
+  url.replace(/\??(\w+)=([^&]*)&?/g, function (_, k, v) {
     if (result[k] !== undefined) {
       var t = result[k];
+      // Cast `t` to `string[]` to ensure that `concat` receives an array
       result[k] = [].concat(t, v);
     } else {
       result[k] = v;
     }
+    // Return an empty string to satisfy the signature of the replace method
+    return '';
   });
-  // if (param === undefined) {
-  //   return result;
-  // } else {
-  //   return result[param] || '';
-  // }
   return result[param] || '';
 }
 /**
@@ -4671,8 +4669,8 @@ function generateRndNum(n) {
   return ret;
 }
 /**
- * @method generateUniqueNum
- * @description 根据时间生成唯一标志的数字 mGenerateUniqueNum() => 1538324722364123。
+ * 根据时间生成唯一标志的数字 mGenerateUniqueNum() => 1538324722364123
+ *
  * @param {number} n 随机数的长度
  * @category Util
  */
@@ -4686,8 +4684,8 @@ function generateUniqueNum(n) {
   return now + rnd;
 }
 /**
- * @method floatToPercent
- * @description 浮点数转为百分比 0.2 => 20%。
+ * 浮点数转为百分比 0.2 => 20%
+ *
  * @param {number} num 浮点数
  * @param {number} fixSize 保留几位浮点数
  * @category Util
@@ -4705,8 +4703,8 @@ function floatToPercent(num, fixSize) {
   return "".concat(ret, "%");
 }
 /**
- * @method floatFixed
- * @description 浮点数保留指定位。
+ * 浮点数保留指定位
+ *
  * @category Util
  */
 function floatFixed(num, size) {
@@ -4716,9 +4714,9 @@ function floatFixed(num, size) {
   return parseFloat(num).toFixed(size);
 }
 /**
- * @method cancelBubble
- * @description 阻止冒泡。
- * @category Util
+ * 阻止冒泡
+ *
+ * @category Event
  */
 function cancelBubble(e) {
   var ev = e || window.event;
@@ -4829,8 +4827,6 @@ function throttle(func, wait, options) {
     options = {};
   }
   options = Object.assign({}, options);
-  // timeout: setTimeout Handle
-  // previous: 上次时间戳
   var context = null;
   var args = null;
   var timeout = null;
@@ -4840,7 +4836,7 @@ function throttle(func, wait, options) {
   var later = function later() {
     previous = options.leading === false ? 0 : mNow();
     timeout = null;
-    result = func.apply(context, args);
+    result = func.apply(this, args);
     if (!timeout) {
       context = args = null;
     }
@@ -4868,7 +4864,7 @@ function throttle(func, wait, options) {
         context = args = null;
       }
     } else if (!timeout && options.trailing !== false) {
-      timeout = setTimeout(later, remaining);
+      timeout = setTimeout(later.bind(context), remaining);
     }
     return result;
   };
@@ -4891,7 +4887,7 @@ function debounce(func, wait, immediate) {
   var timeout = null;
   var timestamp = null;
   var args = null;
-  var result = [null][0];
+  var result = null;
   var later = function later() {
     var last = mNow() - timestamp;
     if (last < wait && last >= 0) {
@@ -5010,37 +5006,26 @@ function getFriendlyInterval(start, end, options) {
  */
 function isNumber(num, options) {
   if (options === void 0) {
-    options = {
-      isNaNAsNumber: false,
-      isUnFiniteAsNumber: false
-    };
+    options = {};
   }
-  var _a = Object.assign({
-      isNaNAsNumber: false,
-      isUnFiniteAsNumber: false
-    }, options),
-    isNaNAsNumber = _a.isNaNAsNumber,
-    isUnFiniteAsNumber = _a.isUnFiniteAsNumber;
-  var ret = true;
-  // 数字类型
+  var _a = options.isNaNAsNumber,
+    isNaNAsNumber = _a === void 0 ? false : _a,
+    _b = options.isFiniteAsNumber,
+    isFiniteAsNumber = _b === void 0 ? false : _b;
   if (typeof num !== 'number') {
-    ret = false;
+    return false;
   }
-  // 无限值
-  if (isUnFiniteAsNumber === false && !isFinite(num)) {
-    // console.log('1333');
-    ret = false;
+  if (!isFiniteAsNumber && !isFinite(num)) {
+    return false;
   }
-  // NaN
-  if (isNaNAsNumber === false && isNaN(num)) {
-    // console.log('2333');
-    ret = false;
+  if (!isNaNAsNumber && isNaN(num)) {
+    return false;
   }
-  return ret;
+  return true;
 }
 /**
- * @method doFn
- * @description 执行有效函数
+ * 执行有效函数
+ *
  * @param {function} fn 等待被执行的未知是否有效的函数
  * @category Util
  */
@@ -5078,7 +5063,7 @@ function doFn(fn) {
  * ```
  *
  * @param {string} key 键
- * @returns {any} 返回值
+ * @returns {void} 返回值
  * @category Cache Data
  */
 function setSessionStorage(key, value) {
@@ -5148,7 +5133,7 @@ function getSessionStorage(key) {
  * ```
  *
  * @param {string} key 键
- * @returns {any} 返回值
+ * @returns {void} 返回值
  * @category Cache Data
  */
 function setLocalStorage(key, value) {
@@ -5427,8 +5412,8 @@ function loadScript(url, options) {
   });
 }
 /**
- * @method mNow
- * @description 获取时间戳
+ * 获取时间戳
+ *
  * @category Util
  */
 function mNow() {
@@ -5454,11 +5439,11 @@ function mNow() {
  */
 function setCookie(name, value, days, domain) {
   var domainParts, expires;
-  var date;
+  // let date: any;
   if (days) {
-    date = new Date();
+    var date = new Date();
     date.setTime(date.getTime() + days * 24 * 60 * 60 * 1000);
-    expires = '; expires=' + date.toGMTString();
+    expires = '; expires=' + date.toUTCString();
   } else {
     expires = '';
   }
@@ -6103,14 +6088,50 @@ function getBrowserInfo() {
   }
 }
 /**
- * @method clearHtml
- * @description 去除HTML标签
+ * 去除 HTML 标签
+ *
  * @param {string} str 带html标签的字符串
  * @returns {string} 字符串
  * @category Util
  */
-function clearHtml(str) {
-  return str.replace(/<\/?.+?>/g, '').replace(/[\r\n]/g, '');
+function clearHtml(str, options) {
+  if (options === void 0) {
+    options = {};
+  }
+  var _a = options.removeNewLine,
+    removeNewLine = _a === void 0 ? false : _a;
+  var ret = '';
+  if (str) {
+    ret = str.replace(/<\/?.+?>/g, '');
+    if (removeNewLine) {
+      ret = ret.replace(/[\r\n]/g, '');
+    }
+  }
+  return ret;
+  // return str.replace(/<\/?.+?>/g, '').replace(/[\r\n]/g, '');
+}
+/**
+ * Sanitizes user input to prevent XSS attacks
+ *
+ * @param input - The input string to sanitize
+ * @returns The sanitized input string
+ */
+function sanitizeInput(input) {
+  var regex = /[&<>"'/]/g;
+  var replacements = {
+    '&': '&amp;',
+    '<': '&lt;',
+    '>': '&gt;',
+    '"': '&quot;',
+    '\'': '&#x27;',
+    '/': '&#x2F;'
+  };
+  if (typeof input !== 'string') {
+    console.error('Input must be a string');
+  }
+  return input.replace(regex, function (match) {
+    return replacements[match];
+  });
 }
 /**
  * 截取字符串，中文算 2 个字节
@@ -6513,15 +6534,12 @@ function isNonEmptyArray(arr) {
 function isValidData(data, attributes, validValue) {
   var ret = false;
   var foundRet = attributes.reduce(function (foundValue, curr) {
-    if (foundValue[curr]) {
-      foundValue = foundValue[curr];
+    if (foundValue && Object.prototype.hasOwnProperty.call(foundValue, curr)) {
+      return foundValue[curr];
     } else {
       return Object.create(null);
     }
-    // console.log('foundValue', foundValue);
-    return foundValue;
   }, data);
-  // console.log('foundRet', foundRet);
   if (foundRet === validValue) {
     ret = true;
   }
@@ -6843,7 +6861,6 @@ function getUrlFileType(url) {
  * The `src` attribute should contain `width` and/or `height` values in the format "width=100" or "height=100".
  * If jQuery is available, this function uses jQuery to select the images. Otherwise, it uses pure JavaScript.
  *
- *
  * @example
  * ```
  * // Example images with `src` attributes containing `width` and/or `height` values
@@ -6863,18 +6880,21 @@ function setImgWidHeiBySrc() {
   var $ = window.jQuery || window.$;
   if ($) {
     // Use jQuery to select all images on the page
-    $('img').each(function () {
+    var images = $('img');
+    if (!(images && images.length)) return false;
+    images.each(function () {
       var $this = $(this);
       if (!$this) return;
       // Get the `src` attribute of the image
       var src = $this.attr('src');
-      if (!src) return;
+      var canMatch = src && typeof src === 'string' && src.length;
+      if (!canMatch) return;
       // Use regular expressions to extract the `width` and `height` values from the `src` attribute
       var width = src.match(/width=([0-9]+[a-z%]*)/);
       var height = src.match(/height=([0-9]+[a-z%]*)/);
       // Set the width and height of the image using jQuery's `width()` and `height()` methods
-      if (width && width[1]) $this.width(width[1]);
-      if (height && height[1]) $this.height(height[1]);
+      if (width && isNonEmptyArray(width) && width[1]) $this.width(width[1]);
+      if (height && isNonEmptyArray(height) && height[1]) $this.height(height[1]);
     });
     return true;
   } else {
@@ -6883,20 +6903,83 @@ function setImgWidHeiBySrc() {
     if (images.length > 0) {
       // Loop through each image and set its width and height based on the `src` attribute
       Array.from(images).forEach(function (img) {
+        var $this = img;
+        if (!$this) return;
         // Get the `src` attribute of the image
-        var src = img.getAttribute('src');
+        var src = $this.getAttribute('src');
+        var canMatch = src && typeof src === 'string' && src.length;
+        if (!canMatch) return;
         // Use regular expressions to extract the `width` and `height` values from the `src` attribute
-        var width = src ? src.match(/width=([0-9]+[a-z%]*)/) : null;
-        var height = src ? src.match(/height=([0-9]+[a-z%]*)/) : null;
+        var width = src.match(/width=([0-9]+[a-z%]*)/);
+        var height = src.match(/height=([0-9]+[a-z%]*)/);
         // Set the width and height of the image using the `style.width` and `style.height` properties
-        if (width && width[1]) img.style.width = width[1];
-        if (height && height[1]) img.style.height = height[1];
+        if (width && isNonEmptyArray(width) && width[1]) $this.style.width = width[1];
+        if (height && isNonEmptyArray(height) && height[1]) $this.style.height = height[1];
       });
       return true;
     }
   }
   return false;
 }
+/**
+ * Generate the inline style string from the given parameters, First parameter is the ClassNames, Second parameter is the style array.
+ *
+ * @example
+ * ```js
+ * console.log(genStyleString('a', [ 'color:red' ])); // '.a{color:red;}'
+ * console.log(genStyleString('b', [ 'color:red', 'font-size:12px' ])); // '.b{color:red;font-size:12px;}'
+ * ```
+ *
+ * @param {string} className
+ * @param {Array} styleArray
+ * @returns {string} Return the inline style string.
+ * @category DOM
+ */
+function genStyleString(className, styleArray) {
+  var style = '';
+  if (styleArray && styleArray.length > 0) {
+    // It's wrong. Last item will not include `;`.
+    // style = styleArray.join(';');
+    style = styleArray.join(';') + ';';
+  }
+  return ".".concat(className, "{").concat(style, "}");
+}
+/**
+ * Load the image from the given url.
+ * The target image will be loaded in the background, and the Promise status will change after the image is loaded.
+ * If the image fails to load, the Promise status will change to `reject`.
+ * If the image is loaded successfully, the Promise status will change to `resolve`.
+ * If the image is loaded successfully, the Promise will return the image object.
+ * If the image fails to load, the Promise will return the error object.
+ * The method will help Web to preload the image. And the image will be cached by the browser.
+ * We can use it to implement the lazy loading of images.
+ * The method will not add the image to the DOM.
+ *
+ * @example
+ * ```js
+ * loadImage('https://example.com/example.png').then((img) => {
+ *  console.log(img);
+ * }).catch((err) => {
+ *  console.log(err);
+ * });
+ * ```
+ *
+ * @param {string} url - The image url.
+ * @returns {Promise} Return the Promise object.
+ * @category Load Resource
+ */
+function loadImage(url) {
+  return new Promise(function (resolve, reject) {
+    var img = new Image();
+    img.onload = function () {
+      resolve(img);
+    };
+    img.onerror = function (err) {
+      reject(err);
+    };
+    img.src = url;
+  });
+}
 
 exports.addClass = addClass;
 exports.addEvent = addEvent;
@@ -6919,6 +7002,7 @@ exports.floatToPercent = floatToPercent;
 exports.formatDate = formatDate;
 exports.genCustomConsole = genCustomConsole;
 exports.genHashCode = genHashCode;
+exports.genStyleString = genStyleString;
 exports.generateRndNum = generateRndNum;
 exports.generateUniqueNum = generateUniqueNum;
 exports.getBrowserInfo = getBrowserInfo;
@@ -6948,12 +7032,14 @@ exports.isValidEmail = isValidEmail;
 exports.isValidPhoneNumber = isValidPhoneNumber;
 exports.isValidUrl = isValidUrl;
 exports.loadCSS = loadCSS;
+exports.loadImage = loadImage;
 exports.loadScript = loadScript;
 exports.mNow = mNow;
 exports.mTrim = mTrim;
 exports.newLine = newLine;
 exports.removeClass = removeClass;
 exports.removeEvent = removeEvent;
+exports.sanitizeInput = sanitizeInput;
 exports.setCookie = setCookie;
 exports.setImgWidHeiBySrc = setImgWidHeiBySrc;
 exports.setLocalStorage = setLocalStorage;