react-util-tools 1.0.12 → 1.0.21

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-util-tools",
-  "version": "1.0.12",
+  "version": "1.0.21",
   "description": "A collection of useful utilities: throttle, debounce, date formatting, device detection, money formatting, decimal calculations and more",
   "type": "module",
   "main": "dist/index.cjs",

package/src/cookie/README.md

@@ -0,0 +1,142 @@
+# Cookie 工具
+
+提供常用的 Cookie 操作方法。
+
+## 方法列表
+
+### setCookie
+
+设置 Cookie。
+
+```typescript
+setCookie(name: string, value: string, options?: CookieOptions): void
+```
+
+**参数：**
+- `name`: Cookie 名称
+- `value`: Cookie 值
+- `options`: 可选配置
+  - `expires`: 过期时间（秒数或 Date 对象）
+  - `path`: Cookie 路径
+  - `domain`: Cookie 域名
+  - `secure`: 是否仅通过 HTTPS 传输
+  - `sameSite`: SameSite 属性（'Strict' | 'Lax' | 'None'）
+
+**示例：**
+```typescript
+import { setCookie } from './cookie';
+
+// 设置简单 Cookie
+setCookie('username', 'john');
+
+// 设置带过期时间的 Cookie（7天）
+setCookie('token', 'abc123', { expires: 7 * 24 * 60 * 60 });
+
+// 设置完整配置的 Cookie
+setCookie('session', 'xyz789', {
+  expires: new Date('2025-12-31'),
+  path: '/',
+  domain: '.example.com',
+  secure: true,
+  sameSite: 'Strict'
+});
+```
+
+### getCookie
+
+获取指定名称的 Cookie 值。
+
+```typescript
+getCookie(name: string): string | null
+```
+
+**示例：**
+```typescript
+import { getCookie } from './cookie';
+
+const username = getCookie('username');
+console.log(username); // 'john' 或 null
+```
+
+### removeCookie
+
+删除指定名称的 Cookie。
+
+```typescript
+removeCookie(name: string, options?: Pick<CookieOptions, 'path' | 'domain'>): void
+```
+
+**注意：** path 和 domain 需要与设置时保持一致才能正确删除。
+
+**示例：**
+```typescript
+import { removeCookie } from './cookie';
+
+removeCookie('username');
+
+// 删除指定 path 和 domain 的 Cookie
+removeCookie('session', { path: '/', domain: '.example.com' });
+```
+
+### hasCookie
+
+检查指定名称的 Cookie 是否存在。
+
+```typescript
+hasCookie(name: string): boolean
+```
+
+**示例：**
+```typescript
+import { hasCookie } from './cookie';
+
+if (hasCookie('token')) {
+  console.log('用户已登录');
+}
+```
+
+### getAllCookies
+
+获取所有 Cookie 的键值对。
+
+```typescript
+getAllCookies(): Record<string, string>
+```
+
+**示例：**
+```typescript
+import { getAllCookies } from './cookie';
+
+const cookies = getAllCookies();
+console.log(cookies); // { username: 'john', token: 'abc123', ... }
+```
+
+### clearAllCookies
+
+清除所有 Cookie。
+
+```typescript
+clearAllCookies(options?: Pick<CookieOptions, 'path' | 'domain'>): void
+```
+
+**示例：**
+```typescript
+import { clearAllCookies } from './cookie';
+
+clearAllCookies();
+
+// 清除指定 path 的所有 Cookie
+clearAllCookies({ path: '/' });
+```
+
+## 类型定义
+
+```typescript
+interface CookieOptions {
+  expires?: number | Date;  // 过期时间（秒数或 Date 对象）
+  path?: string;            // Cookie 路径
+  domain?: string;          // Cookie 域名
+  secure?: boolean;         // 是否仅 HTTPS
+  sameSite?: 'Strict' | 'Lax' | 'None';  // SameSite 属性
+}
+```

package/src/cookie/index.ts

@@ -0,0 +1,116 @@
+/**
+ * Cookie 操作工具类
+ */
+
+export interface CookieOptions {
+  expires?: number | Date;
+  path?: string;
+  domain?: string;
+  secure?: boolean;
+  sameSite?: 'Strict' | 'Lax' | 'None';
+}
+
+/**
+ * 设置 Cookie
+ * @param name Cookie 名称
+ * @param value Cookie 值
+ * @param options Cookie 配置选项
+ */
+export function setCookie(name: string, value: string, options: CookieOptions = {}): void {
+  let cookieString = `${encodeURIComponent(name)}=${encodeURIComponent(value)}`;
+
+  if (options.expires) {
+    const expires = options.expires instanceof Date 
+      ? options.expires 
+      : new Date(Date.now() + options.expires * 1000);
+    cookieString += `; expires=${expires.toUTCString()}`;
+  }
+
+  if (options.path) {
+    cookieString += `; path=${options.path}`;
+  }
+
+  if (options.domain) {
+    cookieString += `; domain=${options.domain}`;
+  }
+
+  if (options.secure) {
+    cookieString += '; secure';
+  }
+
+  if (options.sameSite) {
+    cookieString += `; SameSite=${options.sameSite}`;
+  }
+
+  document.cookie = cookieString;
+}
+
+/**
+ * 获取 Cookie
+ * @param name Cookie 名称
+ * @returns Cookie 值，不存在则返回 null
+ */
+export function getCookie(name: string): string | null {
+  const nameEQ = encodeURIComponent(name) + '=';
+  const cookies = document.cookie.split(';');
+
+  for (let cookie of cookies) {
+    cookie = cookie.trim();
+    if (cookie.indexOf(nameEQ) === 0) {
+      return decodeURIComponent(cookie.substring(nameEQ.length));
+    }
+  }
+
+  return null;
+}
+
+/**
+ * 删除 Cookie
+ * @param name Cookie 名称
+ * @param options Cookie 配置选项（path 和 domain 需要与设置时一致）
+ */
+export function removeCookie(name: string, options: Pick<CookieOptions, 'path' | 'domain'> = {}): void {
+  setCookie(name, '', {
+    ...options,
+    expires: new Date(0)
+  });
+}
+
+/**
+ * 检查 Cookie 是否存在
+ * @param name Cookie 名称
+ * @returns 是否存在
+ */
+export function hasCookie(name: string): boolean {
+  return getCookie(name) !== null;
+}
+
+/**
+ * 获取所有 Cookie
+ * @returns Cookie 键值对对象
+ */
+export function getAllCookies(): Record<string, string> {
+  const cookies: Record<string, string> = {};
+  const cookieArray = document.cookie.split(';');
+
+  for (let cookie of cookieArray) {
+    cookie = cookie.trim();
+    const [name, ...valueParts] = cookie.split('=');
+    if (name) {
+      cookies[decodeURIComponent(name)] = decodeURIComponent(valueParts.join('='));
+    }
+  }
+
+  return cookies;
+}
+
+/**
+ * 清除所有 Cookie
+ * @param options Cookie 配置选项（path 和 domain）
+ */
+export function clearAllCookies(options: Pick<CookieOptions, 'path' | 'domain'> = {}): void {
+  const cookies = getAllCookies();
+  for (const name in cookies) {
+    removeCookie(name, options);
+  }
+}

package/src/format/index.ts

@@ -187,3 +187,68 @@ export function formatPercent(
   const num = multiply ? value * 100 : value
   return num.toFixed(decimals) + '%'
 }
+
+/**
+ * 邮箱脱敏：只展示前3个字符+@和后面的字符串，中间用***表示
+ * @param email 邮箱地址
+ * @returns 脱敏后的邮箱地址
+ * @example
+ * maskEmail('dj49846917@proton.me') // 'dj4***@proton.me'
+ * maskEmail('abc@example.com') // 'abc***@example.com'
+ */
+export function maskEmail(email: string): string {
+  if (!email || typeof email !== 'string') {
+    return ''
+  }
+
+  const atIndex = email.indexOf('@')
+  if (atIndex <= 0) {
+    return email // 无效邮箱，返回原值
+  }
+
+  const localPart = email.substring(0, atIndex)
+  const domainPart = email.substring(atIndex)
+
+  // 只展示前3个字符
+  const visiblePart = localPart.substring(0, 3)
+  
+  return `${visiblePart}***${domainPart}`
+}
+
+/**
+ * 邮箱解脱敏：将脱敏的邮箱还原（需要提供原始邮箱）
+ * @param maskedEmail 脱敏后的邮箱地址
+ * @param originalEmail 原始邮箱地址
+ * @returns 解脱敏后的邮箱地址
+ * @example
+ * unmaskEmail('dj4***@proton.me', 'dj49846917@proton.me') // 'dj49846917@proton.me'
+ */
+export function unmaskEmail(maskedEmail: string, originalEmail: string): string {
+  if (!maskedEmail || !originalEmail) {
+    return ''
+  }
+
+  // 验证脱敏邮箱格式
+  if (!maskedEmail.includes('***@')) {
+    return maskedEmail // 不是脱敏格式，直接返回
+  }
+
+  // 验证原始邮箱和脱敏邮箱是否匹配
+  const maskedParts = maskedEmail.split('***@')
+  const atIndex = originalEmail.indexOf('@')
+  
+  if (atIndex <= 0) {
+    return maskedEmail // 原始邮箱无效
+  }
+
+  const originalPrefix = originalEmail.substring(0, 3)
+  const originalDomain = originalEmail.substring(atIndex + 1)
+  const maskedDomain = maskedParts[1]
+
+  // 验证前缀和域名是否匹配
+  if (maskedParts[0] === originalPrefix && maskedDomain === originalDomain) {
+    return originalEmail
+  }
+
+  return maskedEmail // 不匹配，返回脱敏邮箱
+}