react-util-tools 1.0.24 → 1.0.26

package/dist/index.d.ts

@@ -1,5 +1,8 @@
 import Decimal from 'decimal.js';
 export { default as Decimal, Decimal as DecimalType } from 'decimal.js';
+import * as XLSX from 'xlsx';
+export { XLSX };
+export { BookType, CellObject, JSON2SheetOpts, ParsingOptions, Range, Sheet2JSONOpts, WorkBook, WorkSheet, WritingOptions } from 'xlsx';
 
 declare function throttleFn<T extends (...args: any[]) => any>(fn: T, wait?: number, options?: {
     leading?: boolean;
@@ -167,4 +170,68 @@ declare function floor(value: number | string | Decimal, decimalPlaces?: number)
 declare function abs(value: number | string | Decimal): number;
 declare function negate(value: number | string | Decimal): number;
 
-export { type CookieOptions, abs, add, addDaysToDate, addDaysUTC, addMonthsToDate, addMonthsUTC, ceil, clearAllCookies, debounceFn as debounce, divide, equals, floor, formatDate, formatDateOnly, formatMoney, formatMoneyToChinese, formatNumber, formatPercent, formatRelativeTime, formatTimeOnly, formatUTC, formatUTCDateOnly, formatUTCTimeOnly, fromUTC, getAllCookies, getAllQueryParams, getBrowser, getBrowserEngine, getBrowserVersion, getCookie, getDaysDiff, getDeviceInfo, getDevicePixelRatio, getDeviceType, getEndOfDay, getEndOfMonth, getEndOfWeek, getEndOfYear, getHoursDiff, getMinutesDiff, getOS, getQueryParam, getQueryParamAll, getScreenResolution, getStartOfDay, getStartOfMonth, getStartOfWeek, getStartOfYear, getTimestamp, getTimestampInSeconds, getTimezoneOffset, getTimezoneOffsetHours, getUTCAllWeeksInYear, getUTCDaysDiff, getUTCEndOfDay, getUTCEndOfMonth, getUTCHoursDiff, getUTCMinutesDiff, getUTCNow, getUTCStartOfDay, getUTCStartOfMonth, getUTCTimestamp, getUTCTimestampInSeconds, getUTCWeekEnd, getUTCWeekNumber, getUTCWeekStart, getUTCWeeksInYear, getUTCYearEnd, getUTCYearEndTimestamp, getUTCYearStart, getUTCYearStartTimestamp, getViewportSize, greaterThan, greaterThanOrEqual, hasCookie, isAfterDate, isAndroid, isBeforeDate, isDesktop, isIOS, isMobile, isSameDayDate, isTablet, isTouchDevice, isValidDate, isWeChat, lessThan, lessThanOrEqual, maskEmail, multiply, negate, parseDate, parseMoney, removeCookie, round, setCookie, subDaysFromDate, subDaysUTC, subMonthsFromDate, subMonthsUTC, subtract, throttleFn as throttle, toISOString, toUTC, unmaskEmail };
+declare const read: typeof XLSX.read;
+declare const readFile: typeof XLSX.readFile;
+declare const write: typeof XLSX.write;
+declare const writeFile: typeof XLSX.writeFile;
+declare const writeFileXLSX: typeof XLSX.writeFileXLSX;
+declare const utils: XLSX.XLSX$Utils;
+declare function readExcelFile(file: File, options?: XLSX.ParsingOptions): Promise<XLSX.WorkBook>;
+declare function workbookToJSON<T = any>(workbook: XLSX.WorkBook, sheetName?: string, options?: XLSX.Sheet2JSONOpts): T[];
+declare function jsonToWorkbook<T = any>(data: T[], sheetName?: string, options?: XLSX.JSON2SheetOpts): XLSX.WorkBook;
+declare function exportExcelFile(workbook: XLSX.WorkBook, filename?: string, options?: XLSX.WritingOptions): void;
+declare function exportJSONToExcel<T = any>(data: T[], filename?: string, sheetName?: string, options?: XLSX.WritingOptions): void;
+declare function readExcelToJSON<T = any>(file: File, sheetName?: string, parseOptions?: XLSX.ParsingOptions, jsonOptions?: XLSX.Sheet2JSONOpts): Promise<T[]>;
+declare function getSheetNames(workbook: XLSX.WorkBook): string[];
+declare function getSheet(workbook: XLSX.WorkBook, sheetName: string): XLSX.WorkSheet;
+declare function sheetToCSV(worksheet: XLSX.WorkSheet, options?: XLSX.Sheet2CSVOpts): string;
+declare function sheetToHTML(worksheet: XLSX.WorkSheet, options?: XLSX.Sheet2HTMLOpts): string;
+declare function tableToSheet(table: HTMLElement | string, options?: XLSX.Table2SheetOpts): XLSX.WorkSheet;
+declare function aoaToSheet(data: any[][], options?: XLSX.AOA2SheetOpts): XLSX.WorkSheet;
+declare function sheetToAOA(worksheet: XLSX.WorkSheet, options?: XLSX.Sheet2JSONOpts): any[][];
+
+declare function capitalize(str: string): string;
+declare function camelCase(str: string): string;
+declare function pascalCase(str: string): string;
+declare function snakeCase(str: string): string;
+declare function kebabCase(str: string): string;
+declare function truncate(str: string, length: number, suffix?: string): string;
+declare function trim(str: string): string;
+declare function trimStart(str: string): string;
+declare function trimEnd(str: string): string;
+declare function reverse(str: string): string;
+declare function repeat(str: string, count: number): string;
+declare function padStart(str: string, length: number, padStr?: string): string;
+declare function padEnd(str: string, length: number, padStr?: string): string;
+declare function startsWith(str: string, searchString: string): boolean;
+declare function endsWith(str: string, searchString: string): boolean;
+declare function includes(str: string, searchString: string): boolean;
+declare function replaceAll(str: string, search: string | RegExp, replacement: string): string;
+declare function stripHtml(str: string): string;
+declare function escapeHtml(str: string): string;
+declare function unescapeHtml(str: string): string;
+declare function toLowerCase(str: string): string;
+declare function toUpperCase(str: string): string;
+declare function titleCase(str: string): string;
+declare function isEmpty(str: string): boolean;
+declare function isNotEmpty(str: string): boolean;
+declare function length(str: string): number;
+declare function split(str: string, separator: string | RegExp): string[];
+declare function extractNumbers(str: string): number[];
+declare function removeSpaces(str: string): string;
+declare function normalizeSpaces(str: string): string;
+declare function countOccurrences(str: string, searchString: string): number;
+declare function randomString(length: number, chars?: string): string;
+declare function uuid(): string;
+declare function maskPhone(phone: string): string;
+declare function maskIdCard(idCard: string): string;
+declare function maskBankCard(cardNumber: string): string;
+declare function maskName(name: string): string;
+declare function isValidPhone(phone: string): boolean;
+declare function isValidEmail(email: string): boolean;
+declare function isValidUrl(url: string): boolean;
+declare function isValidIdCard(idCard: string): boolean;
+declare function toBase64(str: string): string;
+declare function fromBase64(base64: string): string;
+
+export { type CookieOptions, abs, add, addDaysToDate, addDaysUTC, addMonthsToDate, addMonthsUTC, aoaToSheet, camelCase, capitalize, ceil, clearAllCookies, countOccurrences, debounceFn as debounce, divide, endsWith, equals, escapeHtml, exportExcelFile, exportJSONToExcel, extractNumbers, floor, formatDate, formatDateOnly, formatMoney, formatMoneyToChinese, formatNumber, formatPercent, formatRelativeTime, formatTimeOnly, formatUTC, formatUTCDateOnly, formatUTCTimeOnly, fromBase64, fromUTC, getAllCookies, getAllQueryParams, getBrowser, getBrowserEngine, getBrowserVersion, getCookie, getDaysDiff, getDeviceInfo, getDevicePixelRatio, getDeviceType, getEndOfDay, getEndOfMonth, getEndOfWeek, getEndOfYear, getHoursDiff, getMinutesDiff, getOS, getQueryParam, getQueryParamAll, getScreenResolution, getSheet, getSheetNames, getStartOfDay, getStartOfMonth, getStartOfWeek, getStartOfYear, getTimestamp, getTimestampInSeconds, getTimezoneOffset, getTimezoneOffsetHours, getUTCAllWeeksInYear, getUTCDaysDiff, getUTCEndOfDay, getUTCEndOfMonth, getUTCHoursDiff, getUTCMinutesDiff, getUTCNow, getUTCStartOfDay, getUTCStartOfMonth, getUTCTimestamp, getUTCTimestampInSeconds, getUTCWeekEnd, getUTCWeekNumber, getUTCWeekStart, getUTCWeeksInYear, getUTCYearEnd, getUTCYearEndTimestamp, getUTCYearStart, getUTCYearStartTimestamp, getViewportSize, greaterThan, greaterThanOrEqual, hasCookie, includes, isAfterDate, isAndroid, isBeforeDate, isDesktop, isEmpty, isIOS, isMobile, isNotEmpty, isSameDayDate, isTablet, isTouchDevice, isValidDate, isValidEmail, isValidIdCard, isValidPhone, isValidUrl, isWeChat, jsonToWorkbook, kebabCase, length, lessThan, lessThanOrEqual, maskBankCard, maskEmail, maskIdCard, maskName, maskPhone, multiply, negate, normalizeSpaces, padEnd, padStart, parseDate, parseMoney, pascalCase, randomString, read, readExcelFile, readExcelToJSON, readFile, removeCookie, removeSpaces, repeat, replaceAll, reverse, round, setCookie, sheetToAOA, sheetToCSV, sheetToHTML, snakeCase, split, startsWith, stripHtml, subDaysFromDate, subDaysUTC, subMonthsFromDate, subMonthsUTC, subtract, tableToSheet, throttleFn as throttle, titleCase, toBase64, toISOString, toLowerCase, toUTC, toUpperCase, trim, trimEnd, trimStart, truncate, unescapeHtml, unmaskEmail, utils, uuid, workbookToJSON, write, writeFile, writeFileXLSX };

package/dist/index.js

@@ -843,19 +843,338 @@ function negate(value) {
     return 0;
   }
 }
+
+// src/excel/index.ts
+import * as XLSX from "xlsx";
+var {
+  read: read2,
+  readFile,
+  write,
+  writeFile: writeFile2,
+  writeFileXLSX,
+  utils: utils2
+} = XLSX;
+function readExcelFile(file, options) {
+  return new Promise((resolve, reject) => {
+    const reader = new FileReader();
+    reader.onload = (e) => {
+      try {
+        const data = e.target?.result;
+        const workbook = XLSX.read(data, options);
+        resolve(workbook);
+      } catch (error) {
+        reject(error);
+      }
+    };
+    reader.onerror = () => {
+      reject(new Error("Failed to read file"));
+    };
+    reader.readAsArrayBuffer(file);
+  });
+}
+function workbookToJSON(workbook, sheetName, options) {
+  const sheet = sheetName ? workbook.Sheets[sheetName] : workbook.Sheets[workbook.SheetNames[0]];
+  if (!sheet) {
+    throw new Error(`Sheet "${sheetName}" not found`);
+  }
+  return XLSX.utils.sheet_to_json(sheet, options);
+}
+function jsonToWorkbook(data, sheetName = "Sheet1", options) {
+  const worksheet = XLSX.utils.json_to_sheet(data, options);
+  const workbook = XLSX.utils.book_new();
+  XLSX.utils.book_append_sheet(workbook, worksheet, sheetName);
+  return workbook;
+}
+function exportExcelFile(workbook, filename = "export.xlsx", options) {
+  XLSX.writeFile(workbook, filename, options);
+}
+function exportJSONToExcel(data, filename = "export.xlsx", sheetName = "Sheet1", options) {
+  const workbook = jsonToWorkbook(data, sheetName);
+  exportExcelFile(workbook, filename, options);
+}
+async function readExcelToJSON(file, sheetName, parseOptions, jsonOptions) {
+  const workbook = await readExcelFile(file, parseOptions);
+  return workbookToJSON(workbook, sheetName, jsonOptions);
+}
+function getSheetNames(workbook) {
+  return workbook.SheetNames;
+}
+function getSheet(workbook, sheetName) {
+  const sheet = workbook.Sheets[sheetName];
+  if (!sheet) {
+    throw new Error(`Sheet "${sheetName}" not found`);
+  }
+  return sheet;
+}
+function sheetToCSV(worksheet, options) {
+  return XLSX.utils.sheet_to_csv(worksheet, options);
+}
+function sheetToHTML(worksheet, options) {
+  return XLSX.utils.sheet_to_html(worksheet, options);
+}
+function tableToSheet(table, options) {
+  return XLSX.utils.table_to_sheet(table, options);
+}
+function aoaToSheet(data, options) {
+  return XLSX.utils.aoa_to_sheet(data, options);
+}
+function sheetToAOA(worksheet, options) {
+  return XLSX.utils.sheet_to_json(worksheet, { ...options, header: 1 });
+}
+
+// src/string/index.ts
+function capitalize(str) {
+  if (!str) return "";
+  return str.charAt(0).toUpperCase() + str.slice(1).toLowerCase();
+}
+function camelCase(str) {
+  if (!str) return "";
+  return str.replace(/[-_\s]+(.)?/g, (_, char) => char ? char.toUpperCase() : "").replace(/^[A-Z]/, (char) => char.toLowerCase());
+}
+function pascalCase(str) {
+  if (!str) return "";
+  const camel = camelCase(str);
+  return camel.charAt(0).toUpperCase() + camel.slice(1);
+}
+function snakeCase(str) {
+  if (!str) return "";
+  return str.replace(/([A-Z])/g, "_$1").replace(/[-\s]+/g, "_").replace(/^_/, "").toLowerCase();
+}
+function kebabCase(str) {
+  if (!str) return "";
+  return str.replace(/([A-Z])/g, "-$1").replace(/[_\s]+/g, "-").replace(/^-/, "").toLowerCase();
+}
+function truncate(str, length2, suffix = "...") {
+  if (!str || str.length <= length2) return str;
+  return str.slice(0, length2) + suffix;
+}
+function trim(str) {
+  return str ? str.trim() : "";
+}
+function trimStart(str) {
+  return str ? str.trimStart() : "";
+}
+function trimEnd(str) {
+  return str ? str.trimEnd() : "";
+}
+function reverse(str) {
+  if (!str) return "";
+  return str.split("").reverse().join("");
+}
+function repeat(str, count) {
+  if (!str || count <= 0) return "";
+  return str.repeat(count);
+}
+function padStart(str, length2, padStr = " ") {
+  if (!str) return padStr.repeat(length2);
+  return str.padStart(length2, padStr);
+}
+function padEnd(str, length2, padStr = " ") {
+  if (!str) return padStr.repeat(length2);
+  return str.padEnd(length2, padStr);
+}
+function startsWith(str, searchString) {
+  if (!str) return false;
+  return str.startsWith(searchString);
+}
+function endsWith(str, searchString) {
+  if (!str) return false;
+  return str.endsWith(searchString);
+}
+function includes(str, searchString) {
+  if (!str) return false;
+  return str.includes(searchString);
+}
+function replaceAll(str, search, replacement) {
+  if (!str) return "";
+  if (typeof search === "string") {
+    return str.split(search).join(replacement);
+  }
+  return str.replace(search, replacement);
+}
+function stripHtml(str) {
+  if (!str) return "";
+  return str.replace(/<[^>]*>/g, "");
+}
+function escapeHtml(str) {
+  if (!str) return "";
+  const map = {
+    "&": "&amp;",
+    "<": "&lt;",
+    ">": "&gt;",
+    '"': "&quot;",
+    "'": "&#39;"
+  };
+  return str.replace(/[&<>"']/g, (char) => map[char]);
+}
+function unescapeHtml(str) {
+  if (!str) return "";
+  const map = {
+    "&amp;": "&",
+    "&lt;": "<",
+    "&gt;": ">",
+    "&quot;": '"',
+    "&#39;": "'"
+  };
+  return str.replace(/&(amp|lt|gt|quot|#39);/g, (entity) => map[entity]);
+}
+function toLowerCase(str) {
+  return str ? str.toLowerCase() : "";
+}
+function toUpperCase(str) {
+  return str ? str.toUpperCase() : "";
+}
+function titleCase(str) {
+  if (!str) return "";
+  return str.toLowerCase().split(" ").map((word) => word.charAt(0).toUpperCase() + word.slice(1)).join(" ");
+}
+function isEmpty(str) {
+  return !str || str.trim().length === 0;
+}
+function isNotEmpty(str) {
+  return !isEmpty(str);
+}
+function length(str) {
+  if (!str) return 0;
+  return Array.from(str).length;
+}
+function split(str, separator) {
+  if (!str) return [];
+  return str.split(separator);
+}
+function extractNumbers(str) {
+  if (!str) return [];
+  const matches = str.match(/\d+(\.\d+)?/g);
+  return matches ? matches.map(Number) : [];
+}
+function removeSpaces(str) {
+  if (!str) return "";
+  return str.replace(/\s+/g, "");
+}
+function normalizeSpaces(str) {
+  if (!str) return "";
+  return str.replace(/\s+/g, " ").trim();
+}
+function countOccurrences(str, searchString) {
+  if (!str || !searchString) return 0;
+  return str.split(searchString).length - 1;
+}
+function randomString(length2, chars = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789") {
+  let result = "";
+  for (let i = 0; i < length2; i++) {
+    result += chars.charAt(Math.floor(Math.random() * chars.length));
+  }
+  return result;
+}
+function uuid() {
+  return "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx".replace(/[xy]/g, (c) => {
+    const r = Math.random() * 16 | 0;
+    const v = c === "x" ? r : r & 3 | 8;
+    return v.toString(16);
+  });
+}
+function maskPhone(phone) {
+  if (!phone || phone.length < 11) return phone;
+  return phone.replace(/(\d{3})\d{4}(\d{4})/, "$1****$2");
+}
+function maskIdCard(idCard) {
+  if (!idCard || idCard.length < 18) return idCard;
+  return idCard.replace(/(\d{6})\d{8}(\d{4})/, "$1********$2");
+}
+function maskBankCard(cardNumber) {
+  if (!cardNumber || cardNumber.length < 16) return cardNumber;
+  return cardNumber.replace(/(\d{4})\d+(\d{4})/, "$1 **** **** $2");
+}
+function maskName(name) {
+  if (!name) return "";
+  if (name.length === 2) {
+    return name.charAt(0) + "*";
+  }
+  return name.charAt(0) + "*".repeat(name.length - 2) + name.charAt(name.length - 1);
+}
+function isValidPhone(phone) {
+  if (!phone) return false;
+  return /^1[3-9]\d{9}$/.test(phone);
+}
+function isValidEmail(email) {
+  if (!email) return false;
+  return /^[^\s@]+@[^\s@]+\.[^\s@]+$/.test(email);
+}
+function isValidUrl(url) {
+  if (!url) return false;
+  try {
+    new URL(url);
+    return true;
+  } catch {
+    return false;
+  }
+}
+function isValidIdCard(idCard) {
+  if (!idCard) return false;
+  return /(^\d{15}$)|(^\d{18}$)|(^\d{17}(\d|X|x)$)/.test(idCard);
+}
+function toBase64(str) {
+  if (!str) return "";
+  if (typeof window !== "undefined" && window.btoa) {
+    try {
+      return window.btoa(encodeURIComponent(str).replace(/%([0-9A-F]{2})/g, (_, p1) => {
+        return String.fromCharCode(parseInt(p1, 16));
+      }));
+    } catch {
+      return "";
+    }
+  }
+  try {
+    const BufferClass = globalThis.Buffer;
+    return BufferClass ? BufferClass.from(str, "utf-8").toString("base64") : "";
+  } catch {
+    return "";
+  }
+}
+function fromBase64(base64) {
+  if (!base64) return "";
+  if (typeof window !== "undefined" && window.atob) {
+    try {
+      const binary = window.atob(base64);
+      const bytes = new Uint8Array(binary.length);
+      for (let i = 0; i < binary.length; i++) {
+        bytes[i] = binary.charCodeAt(i);
+      }
+      return new TextDecoder().decode(bytes);
+    } catch {
+      return "";
+    }
+  }
+  try {
+    const BufferClass = globalThis.Buffer;
+    return BufferClass ? BufferClass.from(base64, "base64").toString("utf-8") : "";
+  } catch {
+    return "";
+  }
+}
 export {
   default2 as Decimal,
+  XLSX,
   abs,
   add,
   addDaysToDate,
   addDaysUTC,
   addMonthsToDate,
   addMonthsUTC,
+  aoaToSheet,
+  camelCase,
+  capitalize,
   ceil,
   clearAllCookies,
+  countOccurrences,
   debounceFn as debounce,
   divide,
+  endsWith,
   equals,
+  escapeHtml,
+  exportExcelFile,
+  exportJSONToExcel,
+  extractNumbers,
   floor,
   formatDate,
   formatDateOnly,
@@ -868,6 +1187,7 @@ export {
   formatUTC,
   formatUTCDateOnly,
   formatUTCTimeOnly,
+  fromBase64,
   fromUTC,
   getAllCookies,
   getAllQueryParams,
@@ -889,6 +1209,8 @@ export {
   getQueryParam,
   getQueryParamAll,
   getScreenResolution,
+  getSheet,
+  getSheetNames,
   getStartOfDay,
   getStartOfMonth,
   getStartOfWeek,
@@ -920,34 +1242,84 @@ export {
   greaterThan,
   greaterThanOrEqual,
   hasCookie,
+  includes,
   isAfterDate,
   isAndroid,
   isBeforeDate,
   isDesktop,
+  isEmpty,
   isIOS,
   isMobile,
+  isNotEmpty,
   isSameDayDate,
   isTablet,
   isTouchDevice,
   isValidDate,
+  isValidEmail,
+  isValidIdCard,
+  isValidPhone,
+  isValidUrl,
   isWeChat,
+  jsonToWorkbook,
+  kebabCase,
+  length,
   lessThan,
   lessThanOrEqual,
+  maskBankCard,
   maskEmail,
+  maskIdCard,
+  maskName,
+  maskPhone,
   multiply,
   negate,
+  normalizeSpaces,
+  padEnd,
+  padStart,
   parseDate,
   parseMoney,
+  pascalCase,
+  randomString,
+  read2 as read,
+  readExcelFile,
+  readExcelToJSON,
+  readFile,
   removeCookie,
+  removeSpaces,
+  repeat,
+  replaceAll,
+  reverse,
   round,
   setCookie,
+  sheetToAOA,
+  sheetToCSV,
+  sheetToHTML,
+  snakeCase,
+  split,
+  startsWith,
+  stripHtml,
   subDaysFromDate,
   subDaysUTC,
   subMonthsFromDate,
   subMonthsUTC,
   subtract,
+  tableToSheet,
   throttleFn as throttle,
+  titleCase,
+  toBase64,
   toISOString,
+  toLowerCase,
   toUTC,
-  unmaskEmail
+  toUpperCase,
+  trim,
+  trimEnd,
+  trimStart,
+  truncate,
+  unescapeHtml,
+  unmaskEmail,
+  utils2 as utils,
+  uuid,
+  workbookToJSON,
+  write,
+  writeFile2 as writeFile,
+  writeFileXLSX
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "react-util-tools",
-  "version": "1.0.24",
-  "description": "A collection of useful utilities: throttle, debounce, date formatting, device detection, money formatting, decimal calculations and more",
+  "version": "1.0.26",
+  "description": "A collection of useful utilities: throttle, debounce, date formatting, device detection, money formatting, decimal calculations, Excel processing and more",
   "type": "module",
   "main": "dist/index.cjs",
   "module": "dist/index.js",
@@ -36,6 +36,10 @@
     "browser-detection",
     "money-format",
     "url-params",
+    "excel",
+    "xlsx",
+    "sheetjs",
+    "cookie",
     "typescript"
   ],
   "author": "alice & bobby",
@@ -62,6 +66,7 @@
   "dependencies": {
     "date-fns": "^4.1.0",
     "date-fns-tz": "^3.2.0",
-    "decimal.js": "^10.6.0"
+    "decimal.js": "^10.6.0",
+    "xlsx": "^0.18.5"
   }
 }