amos-tool 1.5.2 → 1.5.3

package/docs/Logger.html

@@ -336,7 +336,7 @@ isDebug: true
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Thu Mar 09 2023 13:58:14 GMT+0800 (GMT+08:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Thu Mar 16 2023 10:03:24 GMT+0800 (GMT+08:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/global.html

@@ -16595,7 +16595,7 @@ schedule <code>callback</code> to execute after <code>delay</code> ms.</p></td>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Thu Mar 09 2023 13:58:14 GMT+0800 (GMT+08:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Thu Mar 16 2023 10:03:24 GMT+0800 (GMT+08:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/docs/index.html

@@ -785,7 +785,7 @@ convert2BMP(canvas, width, height)</p>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Thu Mar 09 2023 13:58:14 GMT+0800 (GMT+08:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Thu Mar 16 2023 10:03:24 GMT+0800 (GMT+08:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

package/index.d.ts

@@ -252,17 +252,46 @@ declare namespace LocationParam {
    *  completeParam({ token: 'xxddf', id: null }, '/main/sub', true); // `/main/sub?token=xxddf&id=`
    *  // 使用 location.href， 传入两个参数，强制转化 null 值
    *  completeParam({ token: 'xxddf', id: null }, true); // `http://localhost:8080/aaa?token=xxddf&id=`
+   *
+   *  // 叠加值，该方法只会叠加参数，如果需要更新已有字段，以及叠加参数，可以使用 `changeParam`
+   *  completeParam({ token: 'aa-bb-cc', id: '654321' }, 'a/b/c?token=aaa&id=bcdef'); // `a/b/c?token=aaa&id=bcdef&token=aa-bb-cc&id=654321`
    */
   export function completeParam(param: Object, url: string, forceCast: Boolean): string;
   /**
-   * 替换 url 参数
-   * @param href 需要替换参数的 url
-   * @param params 参数对象
+   * 替换 url 参数。如果url中无指定的参数，则自动追加。
+   *
+   * 自动将对象中的 undefined 值，转化为 ''。null 值则直接返回 null 字符串。
+   *
+   * params 参数中的数据格式，建议调用处统一处理为 string 格式。内部仅统一处理 undefined 和 {} 格式。
+   * @param href 需要替换参数的 url。为空字符串则直接返回 href
+   * @param params 参数对象。为空对象，则直接返回 href。
    * @example
+   *  // 无参数，自动追加
+   * changeParam('a/b/d/g', { a: 1, b: 2, c: 3 }); // 'a/b/d/g?a=1&b=2&c=3'
+   *  // 更新已有参数的值
    *  changeParam('a/b/d/g?a=aa&b=bb&c=cc', { a: 1, b: 2, c: 3 }); // 'a/b/d/g?a=1&b=2&c=3'
-   * changeParam('a/b/d/g?a=aa&b=bb&c=cc', { a: 1, b: 2, c: 3, d: 5 }); // 'a/b/d/g?a=1&b=2&c=3&d=5'
+   *  // url 中无参数 d，自动追加参数
+   *  changeParam('a/b/d/g?a=aa&b=bb&c=cc', { a: 1, b: 2, c: 3, d: 5 }); // 'a/b/d/g?a=1&b=2&c=3&d=5'
+   *  // undefined 值转化为 ''
+   *  changeParam('a/b/d/g', { a: 1, b: 2, c: undefined }); // 'a/b/d/g?a=1&b=2&c='
+   *  // null 值转化为 'null'
+   *  changeParam('a/b/d/g', { a: 1, b: null, c: undefined }); // 'a/b/d/g?a=1&b=null&c='
+   *  // [] 和 {} 值。最好不要给参数中传入 {} 值
+   *  changeParam('a/b/d/g', { a: { m: 3 }, b: [1,2] }); // a/b/d/g?a={"m":3}&b=1,2
    */
   export function changeParam(href: String, params: Object): String;
+  /**
+   * encode 参数中的值
+   * @param param
+   * @param keys 需要执行 encode 的字段
+   * @param processor 自定义 encode 方法，默认采用 `encodeURIComponent`
+   * @example
+   *  encodeParam({ name: 'ilex', email: 'aa@qq.com' }, 'email'); // { name: 'ilex', email: 'aa%40qq.com' }
+   *  encodeParam({ info: { hobby: 'coding', phone: '155666688881' } }, 'info'); // { info: '%7B%22hobby%22%3A%22coding%22%2C%22phone%22%3A%22155666688881%22%7D' }
+   *  encodeParam({ split: [1,2,3] }, 'split'); // { split: '%5B1%2C2%2C3%5D' }
+   *  encodeParam({ star: 18 }, 'star', v => v * 2); // { star: 36 }
+   */
+  export function encodeParam(param: {}, keys: String | String[], processor: (arg) => String): {};
   /**
    * 更新浏览器地址栏地址
    * @param param

package/lib/locationParams.js

@@ -1,141 +1,151 @@
 "use strict";
 
 var utils = require("./utils"), _LSFN = function() {
-  var n = [];
+  var t = [];
   return function() {
-    var t = window.location.search;
-    if (utils.isEmpty(t)) throw new Error("the [window.location.search] not empty!");
-    var e = t.length > 1 ? t.substring(1) : null;
-    utils.isNull(e) || (n = [].slice.call(e.split("&")));
+    var n = window.location.search;
+    if (utils.isEmpty(n)) throw new Error("the [window.location.search] not empty!");
+    var i = n.length > 1 ? n.substring(1) : null;
+    utils.isNull(i) || (t = [].slice.call(i.split("&")));
   }(), {
-    getValue: function(t) {
-      n.forEach((function(n) {
-        var e = n.split("=");
-        if (e[0] === t) return e[1];
+    getValue: function(n) {
+      t.forEach((function(t) {
+        var i = t.split("=");
+        if (i[0] === n) return i[1];
       }));
     },
     getParameters: function() {
-      var t = [];
-      return n.forEach((function(n) {
-        t.push(n.split("=")[0]);
-      })), t;
+      var n = [];
+      return t.forEach((function(t) {
+        n.push(t.split("=")[0]);
+      })), n;
     }
   };
 }, _LocationSearch = {
   _keyValuePairs: [],
   init: function() {
-    var n = window.location.search;
-    if (utils.isEmpty(n)) throw new Error("the [window.location.search] not empty!");
-    var t = n.length > 1 ? n.substring(1) : null;
-    return utils.isNull(t) || (_LocationSearch._keyValuePairs = [].slice.call(t.split("&"))), 
+    var t = window.location.search;
+    if (utils.isEmpty(t)) throw new Error("the [window.location.search] not empty!");
+    var n = t.length > 1 ? t.substring(1) : null;
+    return utils.isNull(n) || (_LocationSearch._keyValuePairs = [].slice.call(n.split("&"))), 
     this;
   },
-  getValue: function(n) {
-    _LocationSearch._keyValuePairs.forEach((function(t) {
-      var e = t.split("=");
-      if (e[0] === n) return e[1];
+  getValue: function(t) {
+    _LocationSearch._keyValuePairs.forEach((function(n) {
+      var i = n.split("=");
+      if (i[0] === t) return i[1];
     }));
   },
   getParameters: function() {
-    var n = [];
-    return _LocationSearch._keyValuePairs.forEach((function(t) {
-      n.push(t.split("=")[0]);
-    })), n;
+    var t = [];
+    return _LocationSearch._keyValuePairs.forEach((function(n) {
+      t.push(n.split("=")[0]);
+    })), t;
   }
 }, LocationParam = {
-  parse: function(n) {
-    var t, e, i, r, o;
-    n || (n = window.location.search);
-    var a = {}, c = [];
-    if (!utils.isEmpty(n) && n.length > 1) for (r = 0, o = (c = n.slice(1 + n.indexOf("?"), n.length).split("&")).length; r < o; r++) t = (e = (e = c[r]).split("="))[0], 
-    i = e[1], t in a ? (utils.isArray(a[t]) || (a[t] = [ a[t] ]), a[t].push(decodeURIComponent(i))) : a[t] = decodeURIComponent(i);
+  parse: function(t) {
+    var n, i, e, r, o;
+    t || (t = window.location.search);
+    var a = {}, s = [];
+    if (!utils.isEmpty(t) && t.length > 1) for (r = 0, o = (s = t.slice(1 + t.indexOf("?"), t.length).split("&")).length; r < o; r++) n = (i = (i = s[r]).split("="))[0], 
+    e = i[1], n in a ? (utils.isArray(a[n]) || (a[n] = [ a[n] ]), a[n].push(decodeURIComponent(e))) : a[n] = decodeURIComponent(e);
     return a;
   },
-  paramSearch: function(n, t) {
-    if (utils.isUndefined(t) || utils.isNull(t)) {
-      if (t = window.location.search, utils.isUndefined(n) || utils.isNull(n)) {
-        for (var e = t.substr(1, t.length - 1).split("&"), i = {}, r = 0; r < e.length; r++) {
-          var o = e[r].split("=");
-          1 === o.length ? i[o[0]] = "" : 2 === o.length ? i[o[0]] = decodeURIComponent(o[1]) : console.log("there is something wrong when use [paramSearch]!");
+  paramSearch: function(t, n) {
+    if (utils.isUndefined(n) || utils.isNull(n)) {
+      if (n = window.location.search, utils.isUndefined(t) || utils.isNull(t)) {
+        for (var i = n.substr(1, n.length - 1).split("&"), e = {}, r = 0; r < i.length; r++) {
+          var o = i[r].split("=");
+          1 === o.length ? e[o[0]] = "" : 2 === o.length ? e[o[0]] = decodeURIComponent(o[1]) : console.log("there is something wrong when use [paramSearch]!");
         }
-        return i;
+        return e;
       }
       try {
-        var a = new RegExp(n + "=([^&]+)?");
-        return decodeURIComponent(t.match(a)[1]);
-      } catch (n) {
+        var a = new RegExp(t + "=([^&]+)?");
+        return decodeURIComponent(n.match(a)[1]);
+      } catch (t) {
         return null;
       }
     }
   },
   getLocationParams: function() {
-    var n, t, e = {}, i = window.location.href;
-    if (!utils.isEmpty(i)) {
-      var r = i.indexOf("?");
-      if (r < -1) console.log("the location.href is invalid!"); else for (var o = (i = i.substr(r + 1)).split("&"), a = 0; a < o.length; a++) (r = o[a].indexOf("=")) > 0 && (n = o[a].substring(0, r), 
-      t = o[a].substr(r + 1), e[n] = decodeURIComponent(t));
+    var t, n, i = {}, e = window.location.href;
+    if (!utils.isEmpty(e)) {
+      var r = e.indexOf("?");
+      if (r < -1) console.log("the location.href is invalid!"); else for (var o = (e = e.substr(r + 1)).split("&"), a = 0; a < o.length; a++) (r = o[a].indexOf("=")) > 0 && (t = o[a].substring(0, r), 
+      n = o[a].substr(r + 1), i[t] = decodeURIComponent(n));
     }
-    return e;
+    return i;
   },
-  getLocationParamByName: function(n) {
-    var t = new RegExp("(^|&?)".concat(n, "=([^&]*)(&|$)")), e = window.location.search.substr(1).match(t);
-    return null != e ? decodeURIComponent(e[2]) : null;
+  getLocationParamByName: function(t) {
+    var n = new RegExp("(^|&?)".concat(t, "=([^&]*)(&|$)")), i = window.location.search.substr(1).match(n);
+    return null != i ? decodeURIComponent(i[2]) : null;
   },
-  getParameter: function(n, t) {
-    var e = new RegExp("(\\?|#|&)" + t + "=([^&#]*)(&|#|$)"), i = n.match(e);
-    return i ? i[2] : "";
+  getParameter: function(t, n) {
+    var i = new RegExp("(\\?|#|&)" + n + "=([^&#]*)(&|#|$)"), e = t.match(i);
+    return e ? e[2] : "";
   },
-  extractParam: function(n, t) {
-    if (!n) return null;
-    var e = new RegExp("(^|&?)".concat(t, "=([^&]*)(&|$)")), i = n.substr(1).match(e);
-    return utils.isNil(i) ? null : decodeURIComponent(i[2]);
+  extractParam: function(t, n) {
+    if (!t) return null;
+    var i = new RegExp("(^|&?)".concat(n, "=([^&]*)(&|$)")), e = t.substr(1).match(i);
+    return utils.isNil(e) ? null : decodeURIComponent(e[2]);
   },
-  extractParams: function(n) {
-    var t, e, i = {}, r = n || window.location.href;
+  extractParams: function(t) {
+    var n, i, e = {}, r = t || window.location.href;
     if (!utils.isEmpty(r)) {
       var o = r.indexOf("?");
-      if (o < -1) console.log("the location.href is invalid!"); else for (var a = (r = r.substr(o + 1)).split("&"), c = 0; c < a.length; c++) (o = a[c].indexOf("=")) > 0 && (t = a[c].substring(0, o), 
-      e = a[c].substr(o + 1), i[t] = decodeURIComponent(e));
+      if (o < -1) console.log("the location.href is invalid!"); else for (var a = (r = r.substr(o + 1)).split("&"), s = 0; s < a.length; s++) (o = a[s].indexOf("=")) > 0 && (n = a[s].substring(0, o), 
+      i = a[s].substr(o + 1), e[n] = decodeURIComponent(i));
     }
-    return i;
+    return e;
   },
-  extractParamAll: function(n) {
-    var t, e, i = arguments.length > 1 && void 0 !== arguments[1] && arguments[1], r = {}, o = n || window.location.href;
+  extractParamAll: function(t) {
+    var n, i, e = arguments.length > 1 && void 0 !== arguments[1] && arguments[1], r = {}, o = t || window.location.href;
     if (!utils.isEmpty(o)) {
       var a = o.indexOf("?");
-      if (a < -1) console.log("the location.href is invalid!"); else for (var c = (o = o.substr(a + 1)).split("&"), l = 0; l < c.length; l++) (a = c[l].indexOf("=")) > 0 && (t = c[l].substring(0, a), 
-      e = c[l].substr(a + 1), r[t] = i ? decodeURIComponent(e) : e);
+      if (a < -1) console.log("the location.href is invalid!"); else for (var s = (o = o.substr(a + 1)).split("&"), l = 0; l < s.length; l++) (a = s[l].indexOf("=")) > 0 && (n = s[l].substring(0, a), 
+      i = s[l].substr(a + 1), r[n] = e ? decodeURIComponent(i) : i);
     }
     return r;
   },
-  completeParam: function(n, t, e) {
-    var i = arguments;
-    1 === i.length ? t || (t = window.location.href) : 2 === i.length && utils.isBoolean(t) && (e = t, 
-    t = window.location.href), utils.isUndefined(e) && (e = !1), t || (t = window.location.href);
-    var r = (Object.keys(n) || []).reduce((function(t, i) {
-      var r = n[i];
-      return e && (utils.isNull(r) || utils.isUndefined(r)) && (r = ""), t += "&".concat(i, "=").concat(r);
+  completeParam: function(t, n, i) {
+    var e = arguments;
+    1 === e.length ? n || (n = window.location.href) : 2 === e.length && utils.isBoolean(n) && (i = n, 
+    n = window.location.href), utils.isUndefined(i) && (i = !1), n || (n = window.location.href);
+    var r = (Object.keys(t) || []).reduce((function(n, e) {
+      var r = t[e];
+      return i && (utils.isNull(r) || utils.isUndefined(r)) && (r = ""), n += "&".concat(e, "=").concat(r);
     }), "");
-    return r ? (r = r.slice(1), -1 !== t.indexOf("?") ? t.endsWith("?") ? "".concat(t).concat(r) : "".concat(t, "&").concat(r) : "".concat(t, "?").concat(r)) : t;
+    return r ? (r = r.slice(1), -1 !== n.indexOf("?") ? n.endsWith("?") ? "".concat(n).concat(r) : "".concat(n, "&").concat(r) : "".concat(n, "?").concat(r)) : n;
   },
-  changeParam: function(n, t) {
-    if (!n || utils.isEmpty(t)) return n;
-    var e = n;
-    return Object.keys(t).forEach((function(n) {
-      var i = t[n];
-      utils.isUndefined(i) && (i = ""), e = function(n, t, e) {
-        var i = t + "=([^&]*)", r = t + "=" + e;
-        if (n.match(i)) {
-          var o = new RegExp("(".concat(t, "=)([^&]*)"), "gi");
-          return n.replace(o, r);
+  changeParam: function(t, n) {
+    if (!t || utils.isEmpty(n)) return t;
+    var i = t;
+    return Object.keys(n).forEach((function(t) {
+      var e = n[t];
+      utils.isUndefined(e) ? e = "" : utils.isArray(e) || utils.isObject(e) && (e = JSON.stringify(e)), 
+      i = function(t, n, i) {
+        var e = n + "=([^&]*)", r = n + "=" + i;
+        if (t.match(e)) {
+          var o = new RegExp("(".concat(n, "=)([^&]*)"), "gi");
+          return t.replace(o, r);
         }
-        return n.match("[?]") ? n + "&" + r : n + "?" + r;
-      }(e, n, i);
-    })), e;
+        return t.match("[?]") ? t + "&" + r : t + "?" + r;
+      }(i, t, e);
+    })), i;
+  },
+  encodeParam: function(t, n, i) {
+    if (utils.isNil(n) || !utils.isObject(t)) return t;
+    utils.isString(n) && (n = [ n ]);
+    for (var e = utils.clone(t), r = 0, o = n.length; r < o; r++) {
+      var a = n[r];
+      utils.isNil(e[a]) || (i ? e[a] = i(e[a]) : utils.isString(e[a]) ? e[a] = encodeURIComponent(e[a]) : (utils.isOnlyObject(e[a]) || utils.isArray(e[a])) && (e[a] = encodeURIComponent(JSON.stringify(e[a]))));
+    }
+    return e;
   },
-  replaceUrl: function(n, t) {
-    var e = t || location.href;
-    e = LocationParam.changeParam(e, n), location.replace(e);
+  replaceUrl: function(t, n) {
+    var i = n || location.href;
+    i = LocationParam.changeParam(i, t), location.replace(i);
   },
   LocationSearch: _LocationSearch,
   LSFN: _LSFN

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "amos-tool",
-  "version": "1.5.2",
+  "version": "1.5.3",
   "description": "amos ui tool",
   "main": "index.js",
   "directories": {