util-helpers 4.5.0 → 4.7.0

package/esm/calculateCursorPosition.js

@@ -0,0 +1,63 @@
+import normalizeString from './normalizeString'; // ref: https://github.com/ant-design/ant-design-mobile/blob/v2/components/input-item/index.tsx#L240
+
+/**
+ * 计算输入框的值格式化后光标位置
+ *
+ * @static
+ * @alias module:Other.calculateCursorPosition
+ * @since 4.6.0
+ * @see 格式化手机号码 {@link https://doly-dev.github.io/util-helpers/module-Processor.html#.formatMobile|formatMobile}
+ * @see 格式化银行卡号 {@link https://doly-dev.github.io/util-helpers/module-Processor.html#.formatBankCard|formatBankCard}
+ * @see h5示例 {@link https://2950v9.csb.app/|点击查看}
+ * @see react示例 {@link https://33ccy9.csb.app/|点击查看}
+ * @param {number} prevPos 赋值前的光标位置，onChange/onInput的光标位置 e.target.selectionEnd
+ * @param {string} prevCtrlValue 上一个格式化后的值
+ * @param {string} rawValue 当前输入原值
+ * @param {string} ctrlValue 当前格式化后的值
+ * @param {Object} [options] 配置项
+ * @param {string[]|string} [options.placeholderChar=' '] 占位符
+ * @param {RegExp} [options.maskReg=/\D/g] 需要遮盖的字符规则。默认去掉非数字，意味着 ctrlValue 需要去掉非数字。
+ * @param {'mobile'|'bankCard'} [options.type] 格式化类型，内置手机号码和银行卡号特殊处理
+ * @returns {number} 格式化后的光标位置
+ */
+
+function calculateCursorPosition(prevPos, prevCtrlValue, rawValue, ctrlValue) {
+  var _ref = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : {},
+      _ref$placeholderChar = _ref.placeholderChar,
+      placeholderChar = _ref$placeholderChar === void 0 ? ' ' : _ref$placeholderChar,
+      _ref$maskReg = _ref.maskReg,
+      maskReg = _ref$maskReg === void 0 ? /\D/g : _ref$maskReg,
+      type = _ref.type;
+
+  var realCtrlValue = normalizeString(prevCtrlValue);
+  var realRawValue = normalizeString(rawValue);
+  var placeholderChars = Array.isArray(placeholderChar) ? placeholderChar : [placeholderChar];
+  var editLength = realRawValue.length - realCtrlValue.length;
+  var isAddition = editLength > 0;
+  var pos = prevPos;
+
+  if (isAddition) {
+    var additionStr = realRawValue.substring(pos - editLength, pos);
+    var ctrlCharCount = additionStr.replace(maskReg, '').length;
+    pos -= editLength - ctrlCharCount;
+    var placeholderCharCount = 0;
+
+    while (ctrlCharCount > 0) {
+      if (placeholderChars.indexOf(ctrlValue.charAt(pos - ctrlCharCount + placeholderCharCount)) !== -1) {
+        placeholderCharCount++;
+      } else {
+        ctrlCharCount--;
+      }
+    }
+
+    pos += placeholderCharCount;
+  }
+
+  if (type === 'mobile' && (pos === 4 || pos === 9) || type === 'bankCard' && pos > 0 && pos % 5 === 0) {
+    pos -= 1;
+  }
+
+  return pos;
+}
+
+export default calculateCursorPosition;

package/esm/formatMobile.js

@@ -12,8 +12,15 @@ import normalizeString from './normalizeString';
  * @example
  * formatMobile('13345678900') // '133 4567 8900'
  * formatMobile('13345678900', { char: '-' }) // '133-4567-8900'
+ *
+ * // 脱敏手机号码
  * formatMobile('133****1234') // '133 **** 1234'
  * formatMobile('133****1234', { char: '-' }) // '133-****-1234'
+ *
+ * // 手机号码位数不够
+ * formatMobile('133') // '133'
+ * formatMobile('133456') // '133 456'
+ * formatMobile('13345678') // '133 4567 8'
  */
 
 function formatMobile(mobileNo) {

package/esm/index.js

@@ -44,6 +44,7 @@ export { default as setDataURLPrefix } from './setDataURLPrefix';
 export { default as normalizeString } from './normalizeString';
 export { default as safeDate } from './safeDate';
 export { default as formatMobile } from './formatMobile';
+export { default as padZero } from './padZero';
 /**
  * 数学计算，修正浮点数计算问题
  *
@@ -66,6 +67,7 @@ export { default as round } from './round';
  */
 
 export { default as waitTime } from './waitTime';
+export { default as calculateCursorPosition } from './calculateCursorPosition';
 /**
  * 调试相关
  *

package/esm/normalizeString.js

@@ -5,7 +5,7 @@ import convertToString from './utils/convertToString';
  *
  * @static
  * @alias module:Processor.normalizeString
- * @see 参考 {@link tttps://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Reference/Global_Objects/String#string_instances|String}
+ * @see 参考 {@link https://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Reference/Global_Objects/String#string_instances|String}
  * @since 4.3.0
  * @param {*} value 待处理的值
  * @returns {string} 规整化的值

package/esm/padZero.js

@@ -0,0 +1,41 @@
+import normalizeString from './normalizeString';
+/**
+ * 前置补零
+ *
+ * @static
+ * @alias module:Processor.padZero
+ * @since 4.7.0
+ * @param {string|number} value 要处理的值
+ * @param {number} [size=2] 指定字符串长度
+ * @returns {string} 用零填充数字到给定长度的字符串
+ * @example
+ * padZero(5); // '05'
+ * padZero('5'); // '05'
+ *
+ * padZero(12); // '12'
+ * padZero('12'); // '12'
+ *
+ * padZero(688); // '688'
+ * padZero('688'); // '688'
+ *
+ * padZero(688, 5); // '00688'
+ * padZero('688', 5); // '00688'
+ */
+
+function padZero(value) {
+  var size = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 2;
+  var str = normalizeString(value);
+  var len = str.length;
+
+  if (typeof size !== 'number' || size < 0) {
+    size = 0;
+  }
+
+  if (len < size) {
+    return '0'.repeat(size - len) + str;
+  }
+
+  return str;
+}
+
+export default padZero;

package/lib/calculateCursorPosition.js

@@ -0,0 +1,74 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+
+var _normalizeString = _interopRequireDefault(require("./normalizeString"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
+
+// ref: https://github.com/ant-design/ant-design-mobile/blob/v2/components/input-item/index.tsx#L240
+
+/**
+ * 计算输入框的值格式化后光标位置
+ *
+ * @static
+ * @alias module:Other.calculateCursorPosition
+ * @since 4.6.0
+ * @see 格式化手机号码 {@link https://doly-dev.github.io/util-helpers/module-Processor.html#.formatMobile|formatMobile}
+ * @see 格式化银行卡号 {@link https://doly-dev.github.io/util-helpers/module-Processor.html#.formatBankCard|formatBankCard}
+ * @see h5示例 {@link https://2950v9.csb.app/|点击查看}
+ * @see react示例 {@link https://33ccy9.csb.app/|点击查看}
+ * @param {number} prevPos 赋值前的光标位置，onChange/onInput的光标位置 e.target.selectionEnd
+ * @param {string} prevCtrlValue 上一个格式化后的值
+ * @param {string} rawValue 当前输入原值
+ * @param {string} ctrlValue 当前格式化后的值
+ * @param {Object} [options] 配置项
+ * @param {string[]|string} [options.placeholderChar=' '] 占位符
+ * @param {RegExp} [options.maskReg=/\D/g] 需要遮盖的字符规则。默认去掉非数字，意味着 ctrlValue 需要去掉非数字。
+ * @param {'mobile'|'bankCard'} [options.type] 格式化类型，内置手机号码和银行卡号特殊处理
+ * @returns {number} 格式化后的光标位置
+ */
+function calculateCursorPosition(prevPos, prevCtrlValue, rawValue, ctrlValue) {
+  var _ref = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : {},
+      _ref$placeholderChar = _ref.placeholderChar,
+      placeholderChar = _ref$placeholderChar === void 0 ? ' ' : _ref$placeholderChar,
+      _ref$maskReg = _ref.maskReg,
+      maskReg = _ref$maskReg === void 0 ? /\D/g : _ref$maskReg,
+      type = _ref.type;
+
+  var realCtrlValue = (0, _normalizeString["default"])(prevCtrlValue);
+  var realRawValue = (0, _normalizeString["default"])(rawValue);
+  var placeholderChars = Array.isArray(placeholderChar) ? placeholderChar : [placeholderChar];
+  var editLength = realRawValue.length - realCtrlValue.length;
+  var isAddition = editLength > 0;
+  var pos = prevPos;
+
+  if (isAddition) {
+    var additionStr = realRawValue.substring(pos - editLength, pos);
+    var ctrlCharCount = additionStr.replace(maskReg, '').length;
+    pos -= editLength - ctrlCharCount;
+    var placeholderCharCount = 0;
+
+    while (ctrlCharCount > 0) {
+      if (placeholderChars.indexOf(ctrlValue.charAt(pos - ctrlCharCount + placeholderCharCount)) !== -1) {
+        placeholderCharCount++;
+      } else {
+        ctrlCharCount--;
+      }
+    }
+
+    pos += placeholderCharCount;
+  }
+
+  if (type === 'mobile' && (pos === 4 || pos === 9) || type === 'bankCard' && pos > 0 && pos % 5 === 0) {
+    pos -= 1;
+  }
+
+  return pos;
+}
+
+var _default = calculateCursorPosition;
+exports["default"] = _default;

package/lib/formatMobile.js

@@ -22,8 +22,15 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "d
  * @example
  * formatMobile('13345678900') // '133 4567 8900'
  * formatMobile('13345678900', { char: '-' }) // '133-4567-8900'
+ *
+ * // 脱敏手机号码
  * formatMobile('133****1234') // '133 **** 1234'
  * formatMobile('133****1234', { char: '-' }) // '133-****-1234'
+ *
+ * // 手机号码位数不够
+ * formatMobile('133') // '133'
+ * formatMobile('133456') // '133 456'
+ * formatMobile('13345678') // '133 4567 8'
  */
 function formatMobile(mobileNo) {
   var _ref = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {},

package/lib/index.js

@@ -201,6 +201,12 @@ Object.defineProperty(exports, "formatMobile", {
     return _formatMobile["default"];
   }
 });
+Object.defineProperty(exports, "padZero", {
+  enumerable: true,
+  get: function get() {
+    return _padZero["default"];
+  }
+});
 Object.defineProperty(exports, "plus", {
   enumerable: true,
   get: function get() {
@@ -237,6 +243,12 @@ Object.defineProperty(exports, "waitTime", {
     return _waitTime["default"];
   }
 });
+Object.defineProperty(exports, "calculateCursorPosition", {
+  enumerable: true,
+  get: function get() {
+    return _calculateCursorPosition["default"];
+  }
+});
 Object.defineProperty(exports, "setDisableWarning", {
   enumerable: true,
   get: function get() {
@@ -310,6 +322,8 @@ var _safeDate = _interopRequireDefault(require("./safeDate"));
 
 var _formatMobile = _interopRequireDefault(require("./formatMobile"));
 
+var _padZero = _interopRequireDefault(require("./padZero"));
+
 var _plus = _interopRequireDefault(require("./plus"));
 
 var _minus = _interopRequireDefault(require("./minus"));
@@ -322,6 +336,8 @@ var _round = _interopRequireDefault(require("./round"));
 
 var _waitTime = _interopRequireDefault(require("./waitTime"));
 
+var _calculateCursorPosition = _interopRequireDefault(require("./calculateCursorPosition"));
+
 var _config = require("./utils/config");
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }

package/lib/normalizeString.js

@@ -16,7 +16,7 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "d
  *
  * @static
  * @alias module:Processor.normalizeString
- * @see 参考 {@link tttps://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Reference/Global_Objects/String#string_instances|String}
+ * @see 参考 {@link https://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Reference/Global_Objects/String#string_instances|String}
  * @since 4.3.0
  * @param {*} value 待处理的值
  * @returns {string} 规整化的值

package/lib/padZero.js

@@ -0,0 +1,51 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+
+var _normalizeString = _interopRequireDefault(require("./normalizeString"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
+
+/**
+ * 前置补零
+ *
+ * @static
+ * @alias module:Processor.padZero
+ * @since 4.7.0
+ * @param {string|number} value 要处理的值
+ * @param {number} [size=2] 指定字符串长度
+ * @returns {string} 用零填充数字到给定长度的字符串
+ * @example
+ * padZero(5); // '05'
+ * padZero('5'); // '05'
+ *
+ * padZero(12); // '12'
+ * padZero('12'); // '12'
+ *
+ * padZero(688); // '688'
+ * padZero('688'); // '688'
+ *
+ * padZero(688, 5); // '00688'
+ * padZero('688', 5); // '00688'
+ */
+function padZero(value) {
+  var size = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 2;
+  var str = (0, _normalizeString["default"])(value);
+  var len = str.length;
+
+  if (typeof size !== 'number' || size < 0) {
+    size = 0;
+  }
+
+  if (len < size) {
+    return '0'.repeat(size - len) + str;
+  }
+
+  return str;
+}
+
+var _default = padZero;
+exports["default"] = _default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "util-helpers",
-  "version": "4.5.0",
+  "version": "4.7.0",
   "description": "一个基于业务场景的工具方法库",
   "main": "lib/index.js",
   "module": "esm/index.js",

package/types/calculateCursorPosition.d.ts

@@ -0,0 +1,26 @@
+export default calculateCursorPosition;
+/**
+ * 计算输入框的值格式化后光标位置
+ *
+ * @static
+ * @alias module:Other.calculateCursorPosition
+ * @since 4.6.0
+ * @see 格式化手机号码 {@link https://doly-dev.github.io/util-helpers/module-Processor.html#.formatMobile|formatMobile}
+ * @see 格式化银行卡号 {@link https://doly-dev.github.io/util-helpers/module-Processor.html#.formatBankCard|formatBankCard}
+ * @see h5示例 {@link https://2950v9.csb.app/|点击查看}
+ * @see react示例 {@link https://33ccy9.csb.app/|点击查看}
+ * @param {number} prevPos 赋值前的光标位置，onChange/onInput的光标位置 e.target.selectionEnd
+ * @param {string} prevCtrlValue 上一个格式化后的值
+ * @param {string} rawValue 当前输入原值
+ * @param {string} ctrlValue 当前格式化后的值
+ * @param {Object} [options] 配置项
+ * @param {string[]|string} [options.placeholderChar=' '] 占位符
+ * @param {RegExp} [options.maskReg=/\D/g] 需要遮盖的字符规则。默认去掉非数字，意味着 ctrlValue 需要去掉非数字。
+ * @param {'mobile'|'bankCard'} [options.type] 格式化类型，内置手机号码和银行卡号特殊处理
+ * @returns {number} 格式化后的光标位置
+ */
+declare function calculateCursorPosition(prevPos: number, prevCtrlValue: string, rawValue: string, ctrlValue: string, { placeholderChar, maskReg, type }?: {
+    placeholderChar?: string | string[] | undefined;
+    maskReg?: RegExp | undefined;
+    type?: "mobile" | "bankCard" | undefined;
+} | undefined): number;

package/types/formatMobile.d.ts

@@ -12,8 +12,15 @@ export default formatMobile;
  * @example
  * formatMobile('13345678900') // '133 4567 8900'
  * formatMobile('13345678900', { char: '-' }) // '133-4567-8900'
+ *
+ * // 脱敏手机号码
  * formatMobile('133****1234') // '133 **** 1234'
  * formatMobile('133****1234', { char: '-' }) // '133-****-1234'
+ *
+ * // 手机号码位数不够
+ * formatMobile('133') // '133'
+ * formatMobile('133456') // '133 456'
+ * formatMobile('13345678') // '133 4567 8'
  */
 declare function formatMobile(mobileNo: string, { char }?: {
     char?: string | undefined;

package/types/index.d.ts

@@ -31,10 +31,12 @@ export { default as setDataURLPrefix } from "./setDataURLPrefix";
 export { default as normalizeString } from "./normalizeString";
 export { default as safeDate } from "./safeDate";
 export { default as formatMobile } from "./formatMobile";
+export { default as padZero } from "./padZero";
 export { default as plus } from "./plus";
 export { default as minus } from "./minus";
 export { default as times } from "./times";
 export { default as divide } from "./divide";
 export { default as round } from "./round";
 export { default as waitTime } from "./waitTime";
+export { default as calculateCursorPosition } from "./calculateCursorPosition";
 export { setDisableWarning } from "./utils/config";

package/types/normalizeString.d.ts

@@ -4,7 +4,7 @@ export default normalizeString;
  *
  * @static
  * @alias module:Processor.normalizeString
- * @see 参考 {@link tttps://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Reference/Global_Objects/String#string_instances|String}
+ * @see 参考 {@link https://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Reference/Global_Objects/String#string_instances|String}
  * @since 4.3.0
  * @param {*} value 待处理的值
  * @returns {string} 规整化的值

package/types/padZero.d.ts

@@ -0,0 +1,24 @@
+export default padZero;
+/**
+ * 前置补零
+ *
+ * @static
+ * @alias module:Processor.padZero
+ * @since 4.7.0
+ * @param {string|number} value 要处理的值
+ * @param {number} [size=2] 指定字符串长度
+ * @returns {string} 用零填充数字到给定长度的字符串
+ * @example
+ * padZero(5); // '05'
+ * padZero('5'); // '05'
+ *
+ * padZero(12); // '12'
+ * padZero('12'); // '12'
+ *
+ * padZero(688); // '688'
+ * padZero('688'); // '688'
+ *
+ * padZero(688, 5); // '00688'
+ * padZero('688', 5); // '00688'
+ */
+declare function padZero(value: string | number, size?: number | undefined): string;