@gateweb/react-utils 1.8.0 → 1.9.0

package/dist/cjs/index.d.ts

@@ -301,8 +301,28 @@ declare const formatAmount: (num: number) => string;
  * @example
  *
  * formatString('123456', 1, 4) // '1****6'
+ *
+ * @deprecated use `maskString` instead
  */
 declare const formatStarMask: (str: string, n: number, m: number) => string;
+/**
+ * 將字串的指定位置的以後的字元轉換成星號
+ *
+ * @param str 字串
+ * @param start 起始位置 (從 0 開始計算)
+ * @param length 可選，從起始位置開始要遮罩的字元數量，默認為剩餘所有字元
+ *
+ * @example
+ *
+ * ```js
+ * maskString('123456789', 2) // '12*******'
+ * maskString('123456789', 2, 5) // '12*****89'
+ * maskString('123456789', 0, 15) // '*********'
+ * maskString('123456789', 10) // '123456789' (start out of bounds)
+ * maskString('123456789', -1) // '123456789' (start out of bounds)
+ * ```
+ */
+declare const maskString: (str: string, start: number, length?: number) => string;
 /**
  * format file size to human readable string
  *
@@ -1060,4 +1080,4 @@ declare const getLocalStorage: <T>(key: string, deCode?: boolean) => T | undefin
  */
 declare const setLocalStorage: (key: string, value: Record<string, any>, enCode?: boolean) => void;
 
-export { ByteSize, type PartialBy, QueryProvider, type RequiredBy, type TCountdownActions, adToRocEra, camelCase2PascalCase, camelCase2SnakeCase, camelString2PascalString, camelString2SnakeString, convertBytes, createEnumLikeObject, debounce, deepMerge, downloadFile, extractEnumLikeObject, fakeApi, formatAmount, formatBytes, formatStarMask, generatePeriodArray, getCurrentPeriod, getLocalStorage, getMimeType, invariant, isChinese, isDateString, isDateTimeString, isEmail, isEnglish, isEqual, isNonZeroStart, isNumber, isNumberAtLeastN, isNumberN, isNumberNM, isServer, isTWMobile, isTWPhone, isTimeString, isValidPassword, mergeRefs, objectToSearchParams, omit, omitByValue, pascalCase2CamelCase, pascalCase2SnakeCase, pascalString2CamelString, pascalString2SnakeString, pick, pickByValue, rocEraToAd, searchParamsToObject, setLocalStorage, snakeCase2CamelCase, snakeCase2PascalCase, snakeString2CamelString, snakeString2PascalString, throttle, useCountdown, useQueryContext, useValue, validTaxId, validateDateString, validateFileType, wait };
+export { ByteSize, type PartialBy, QueryProvider, type RequiredBy, type TCountdownActions, adToRocEra, camelCase2PascalCase, camelCase2SnakeCase, camelString2PascalString, camelString2SnakeString, convertBytes, createEnumLikeObject, debounce, deepMerge, downloadFile, extractEnumLikeObject, fakeApi, formatAmount, formatBytes, formatStarMask, generatePeriodArray, getCurrentPeriod, getLocalStorage, getMimeType, invariant, isChinese, isDateString, isDateTimeString, isEmail, isEnglish, isEqual, isNonZeroStart, isNumber, isNumberAtLeastN, isNumberN, isNumberNM, isServer, isTWMobile, isTWPhone, isTimeString, isValidPassword, maskString, mergeRefs, objectToSearchParams, omit, omitByValue, pascalCase2CamelCase, pascalCase2SnakeCase, pascalString2CamelString, pascalString2SnakeString, pick, pickByValue, rocEraToAd, searchParamsToObject, setLocalStorage, snakeCase2CamelCase, snakeCase2PascalCase, snakeString2CamelString, snakeString2PascalString, throttle, useCountdown, useQueryContext, useValue, validTaxId, validateDateString, validateFileType, wait };

package/dist/cjs/index.js

@@ -762,7 +762,31 @@ const transformObjectKey = (obj, transformFunName)=>{
  * @example
  *
  * formatString('123456', 1, 4) // '1****6'
+ *
+ * @deprecated use `maskString` instead
  */ const formatStarMask = (str, n, m)=>str.slice(0, n) + '*'.repeat(m - n + 1) + str.slice(m + 1);
+/**
+ * 將字串的指定位置的以後的字元轉換成星號
+ *
+ * @param str 字串
+ * @param start 起始位置 (從 0 開始計算)
+ * @param length 可選，從起始位置開始要遮罩的字元數量，默認為剩餘所有字元
+ *
+ * @example
+ *
+ * ```js
+ * maskString('123456789', 2) // '12*******'
+ * maskString('123456789', 2, 5) // '12*****89'
+ * maskString('123456789', 0, 15) // '*********'
+ * maskString('123456789', 10) // '123456789' (start out of bounds)
+ * maskString('123456789', -1) // '123456789' (start out of bounds)
+ * ```
+ */ const maskString = (str, start, length)=>{
+    if (start < 0 || start >= str.length) return str;
+    const maxMaskLength = str.length - start;
+    const safeLength = length !== undefined ? Math.max(0, Math.min(length, maxMaskLength)) : maxMaskLength;
+    return str.slice(0, start) + '*'.repeat(safeLength) + str.slice(start + safeLength);
+};
 const FILE_SIZE_UNITS = [
     'Bytes',
     'KB',
@@ -1199,6 +1223,7 @@ exports.isTWMobile = isTWMobile;
 exports.isTWPhone = isTWPhone;
 exports.isTimeString = isTimeString;
 exports.isValidPassword = isValidPassword;
+exports.maskString = maskString;
 exports.mergeRefs = mergeRefs;
 exports.objectToSearchParams = objectToSearchParams;
 exports.omit = omit;

package/dist/es/index.d.mts

@@ -301,8 +301,28 @@ declare const formatAmount: (num: number) => string;
  * @example
  *
  * formatString('123456', 1, 4) // '1****6'
+ *
+ * @deprecated use `maskString` instead
  */
 declare const formatStarMask: (str: string, n: number, m: number) => string;
+/**
+ * 將字串的指定位置的以後的字元轉換成星號
+ *
+ * @param str 字串
+ * @param start 起始位置 (從 0 開始計算)
+ * @param length 可選，從起始位置開始要遮罩的字元數量，默認為剩餘所有字元
+ *
+ * @example
+ *
+ * ```js
+ * maskString('123456789', 2) // '12*******'
+ * maskString('123456789', 2, 5) // '12*****89'
+ * maskString('123456789', 0, 15) // '*********'
+ * maskString('123456789', 10) // '123456789' (start out of bounds)
+ * maskString('123456789', -1) // '123456789' (start out of bounds)
+ * ```
+ */
+declare const maskString: (str: string, start: number, length?: number) => string;
 /**
  * format file size to human readable string
  *
@@ -1060,4 +1080,4 @@ declare const getLocalStorage: <T>(key: string, deCode?: boolean) => T | undefin
  */
 declare const setLocalStorage: (key: string, value: Record<string, any>, enCode?: boolean) => void;
 
-export { ByteSize, type PartialBy, QueryProvider, type RequiredBy, type TCountdownActions, adToRocEra, camelCase2PascalCase, camelCase2SnakeCase, camelString2PascalString, camelString2SnakeString, convertBytes, createEnumLikeObject, debounce, deepMerge, downloadFile, extractEnumLikeObject, fakeApi, formatAmount, formatBytes, formatStarMask, generatePeriodArray, getCurrentPeriod, getLocalStorage, getMimeType, invariant, isChinese, isDateString, isDateTimeString, isEmail, isEnglish, isEqual, isNonZeroStart, isNumber, isNumberAtLeastN, isNumberN, isNumberNM, isServer, isTWMobile, isTWPhone, isTimeString, isValidPassword, mergeRefs, objectToSearchParams, omit, omitByValue, pascalCase2CamelCase, pascalCase2SnakeCase, pascalString2CamelString, pascalString2SnakeString, pick, pickByValue, rocEraToAd, searchParamsToObject, setLocalStorage, snakeCase2CamelCase, snakeCase2PascalCase, snakeString2CamelString, snakeString2PascalString, throttle, useCountdown, useQueryContext, useValue, validTaxId, validateDateString, validateFileType, wait };
+export { ByteSize, type PartialBy, QueryProvider, type RequiredBy, type TCountdownActions, adToRocEra, camelCase2PascalCase, camelCase2SnakeCase, camelString2PascalString, camelString2SnakeString, convertBytes, createEnumLikeObject, debounce, deepMerge, downloadFile, extractEnumLikeObject, fakeApi, formatAmount, formatBytes, formatStarMask, generatePeriodArray, getCurrentPeriod, getLocalStorage, getMimeType, invariant, isChinese, isDateString, isDateTimeString, isEmail, isEnglish, isEqual, isNonZeroStart, isNumber, isNumberAtLeastN, isNumberN, isNumberNM, isServer, isTWMobile, isTWPhone, isTimeString, isValidPassword, maskString, mergeRefs, objectToSearchParams, omit, omitByValue, pascalCase2CamelCase, pascalCase2SnakeCase, pascalString2CamelString, pascalString2SnakeString, pick, pickByValue, rocEraToAd, searchParamsToObject, setLocalStorage, snakeCase2CamelCase, snakeCase2PascalCase, snakeString2CamelString, snakeString2PascalString, throttle, useCountdown, useQueryContext, useValue, validTaxId, validateDateString, validateFileType, wait };

package/dist/es/index.mjs

@@ -756,7 +756,31 @@ const transformObjectKey = (obj, transformFunName)=>{
  * @example
  *
  * formatString('123456', 1, 4) // '1****6'
+ *
+ * @deprecated use `maskString` instead
  */ const formatStarMask = (str, n, m)=>str.slice(0, n) + '*'.repeat(m - n + 1) + str.slice(m + 1);
+/**
+ * 將字串的指定位置的以後的字元轉換成星號
+ *
+ * @param str 字串
+ * @param start 起始位置 (從 0 開始計算)
+ * @param length 可選，從起始位置開始要遮罩的字元數量，默認為剩餘所有字元
+ *
+ * @example
+ *
+ * ```js
+ * maskString('123456789', 2) // '12*******'
+ * maskString('123456789', 2, 5) // '12*****89'
+ * maskString('123456789', 0, 15) // '*********'
+ * maskString('123456789', 10) // '123456789' (start out of bounds)
+ * maskString('123456789', -1) // '123456789' (start out of bounds)
+ * ```
+ */ const maskString = (str, start, length)=>{
+    if (start < 0 || start >= str.length) return str;
+    const maxMaskLength = str.length - start;
+    const safeLength = length !== undefined ? Math.max(0, Math.min(length, maxMaskLength)) : maxMaskLength;
+    return str.slice(0, start) + '*'.repeat(safeLength) + str.slice(start + safeLength);
+};
 const FILE_SIZE_UNITS = [
     'Bytes',
     'KB',
@@ -1152,4 +1176,4 @@ function mergeRefs(refs) {
     return dayjs(endMonth, 'YYYYMM').subtract(1911, 'year').format('YYYYMM').substring(1);
 };
 
-export { ByteSize, adToRocEra, camelCase2PascalCase, camelCase2SnakeCase, camelString2PascalString, camelString2SnakeString, convertBytes, createEnumLikeObject, debounce, deepMerge, extractEnumLikeObject, fakeApi, formatAmount, formatBytes, formatStarMask, generatePeriodArray, getCurrentPeriod, getMimeType, invariant, isChinese, isDateString, isDateTimeString, isEmail, isEnglish, isEqual, isNonZeroStart, isNumber, isNumberAtLeastN, isNumberN, isNumberNM, isServer, isTWMobile, isTWPhone, isTimeString, isValidPassword, mergeRefs, objectToSearchParams, omit, omitByValue, pascalCase2CamelCase, pascalCase2SnakeCase, pascalString2CamelString, pascalString2SnakeString, pick, pickByValue, rocEraToAd, searchParamsToObject, snakeCase2CamelCase, snakeCase2PascalCase, snakeString2CamelString, snakeString2PascalString, throttle, useValue, validTaxId, validateDateString, validateFileType, wait };
+export { ByteSize, adToRocEra, camelCase2PascalCase, camelCase2SnakeCase, camelString2PascalString, camelString2SnakeString, convertBytes, createEnumLikeObject, debounce, deepMerge, extractEnumLikeObject, fakeApi, formatAmount, formatBytes, formatStarMask, generatePeriodArray, getCurrentPeriod, getMimeType, invariant, isChinese, isDateString, isDateTimeString, isEmail, isEnglish, isEqual, isNonZeroStart, isNumber, isNumberAtLeastN, isNumberN, isNumberNM, isServer, isTWMobile, isTWPhone, isTimeString, isValidPassword, maskString, mergeRefs, objectToSearchParams, omit, omitByValue, pascalCase2CamelCase, pascalCase2SnakeCase, pascalString2CamelString, pascalString2SnakeString, pick, pickByValue, rocEraToAd, searchParamsToObject, snakeCase2CamelCase, snakeCase2PascalCase, snakeString2CamelString, snakeString2PascalString, throttle, useValue, validTaxId, validateDateString, validateFileType, wait };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gateweb/react-utils",
-  "version": "1.8.0",
+  "version": "1.9.0",
   "description": "React Utils for GateWeb",
   "homepage": "https://github.com/GatewebSolutions/react-utils",
   "files": [