create-pardx-scaffold 0.1.0

package/template/packages/utils/string.util.ts

@@ -0,0 +1,159 @@
+import { pinyin } from 'pinyin-pro';
+
+import { validate as uuidValidate } from 'uuid';
+import { default as objectUtil } from './object.util';
+import { v4 as uuidv4 } from 'uuid';
+import { HeaderData } from './headers';
+
+export default {
+  isUUID(str: any): boolean {
+    if (objectUtil.getType(str) !== 'string') {
+      return false;
+    }
+    return uuidValidate(str);
+  },
+
+  stringGen(len: number = 6) {
+    let text = '';
+    const charset = 'abcdefghijklmnopqrstuvwxyz0123456789';
+    for (let i = 0; i < len; i++)
+      text += charset.charAt(Math.floor(Math.random() * charset.length));
+    return text;
+  },
+
+  formatCode(input: string): string {
+    return input.replace(/[Oo]/g, '0').replace(/[Il]/g, '1');
+  },
+
+  generateCode(length: number): string {
+    const characters =
+      'ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnpqrstuvwxyz0123456789'; // Removed 'I', 'O' and 'l'
+    let result = '';
+    for (let i = 0; i < length; i++) {
+      result += characters.charAt(
+        Math.floor(Math.random() * characters.length),
+      );
+    }
+    return result;
+  },
+
+  toCamelCase(inputString: string): string {
+    return inputString.replace(/_+(\w)/g, (match: string, letter: string) =>
+      letter.toUpperCase(),
+    );
+  },
+
+  escapeMongoRegexSpecialChars(inputString: string): string {
+    // MongoDB中的正则表达式特殊字符
+    const mongoRegexSpecialChars = /[\.^$*{[\]|}\\+?\-()]/g;
+
+    // 使用replace函数和回调函数来替换特殊字符
+    return inputString.replace(mongoRegexSpecialChars, (match) => `\\${match}`);
+  },
+
+  generateString(input: string, suffixLength = 3): string {
+    // 判断是否为中文
+    const isChinese = /^[\u4e00-\u9fa5]+$/.test(input);
+
+    let resultString = '';
+    if (isChinese) {
+      // 中文转拼音
+      resultString = pinyin(input, {
+        type: 'string',
+        separator: '-',
+      });
+      // // 拼接拼音
+      // resultString = pinyinArray.flat().join('')
+    } else {
+      // 已经是英文，直接使用原字符串
+      resultString = input;
+    }
+
+    // 生成随机后缀
+    const randomSuffix = Math.random()
+      .toString(32)
+      .substring(2, suffixLength + 2);
+
+    // 添加后缀
+    return `${resultString}-${randomSuffix}`;
+  },
+
+  createPathAccessor(path: string[]): {
+    get: (index: number) => string | undefined;
+  } {
+    const accumulatedPaths: string[] = [];
+    let currentPath = '';
+
+    for (const segment of path) {
+      currentPath += '/' + segment;
+      accumulatedPaths.push(currentPath);
+    }
+
+    return {
+      get: (index: number) => {
+        if (index < 0 || index >= accumulatedPaths.length) {
+          return undefined;
+        }
+        return accumulatedPaths[index];
+      },
+    };
+  },
+
+  splitString(
+    inputString: string,
+    splitChar: string = '/',
+    slice?: number,
+  ): string[] {
+    // 使用split方法按照'/'字符分割字符串
+    const parts = inputString
+      .trim()
+      .split(splitChar)
+      .filter((id) => id !== '');
+    if (slice) {
+      // 如果指定了slice参数，则截取前slice个部分
+      return parts.length > slice ? parts.slice(slice) : [];
+    }
+    return parts;
+  },
+
+  getDeviceId(deviceInfo: HeaderData): string {
+    return (
+      deviceInfo?.os ||
+      'unknown' + '-' + deviceInfo?.platform ||
+      'unknown' + '-' + deviceInfo?.deviceid ||
+      uuidv4()
+    );
+  },
+
+  trimSlashes(str: string): string {
+    return (str || '').replace(/^\/+|\/+$/g, '');
+  },
+
+  maskPhoneNumber(mobile: string): string {
+    // 假设手机号码是11位，并且已经进行了格式验证
+    // 如果手机号码长度不是11位，则可能需要额外的处理
+    if (mobile.length !== 11) {
+      throw new Error('Invalid phone number length. Expected 11 digits.');
+    }
+    // 使用模板字符串和切片操作来替换中间四位为'※'
+    return `${mobile.slice(0, 3)}****${mobile.slice(7)}`;
+  },
+
+  generateSessionId(user_id: string): string {
+    // 获取当前时间戳，格式：YYYYMMDDHHMMSS
+    const now = new Date();
+    const timestamp =
+      now.getFullYear().toString() +
+      String(now.getMonth() + 1).padStart(2, '0') +
+      String(now.getDate()).padStart(2, '0') +
+      String(now.getHours()).padStart(2, '0') +
+      String(now.getMinutes()).padStart(2, '0') +
+      String(now.getSeconds()).padStart(2, '0');
+
+    // 生成8位随机字符串
+    const randomStr = this.stringGen(8);
+
+    // 组合：时间戳+随机字符串+user_id
+    return `${timestamp}${randomStr}${user_id}`;
+  },
+};

package/template/packages/utils/timer.util.ts

@@ -0,0 +1,210 @@
+import * as moment from 'moment-timezone';
+export default {
+  timestampToTimes(timestamp: number): string {
+    let date = new Date(timestamp); //时间戳为10位需*1000，时间戳为13位的话不需乘1000
+    let Y = date.getFullYear() + '-';
+    let M =
+      (date.getMonth() + 1 < 10
+        ? '0' + (date.getMonth() + 1)
+        : date.getMonth() + 1) + '-';
+    let D = (date.getDate() < 10 ? '0' + date.getDate() : date.getDate()) + ' ';
+
+    return Y + M + D;
+  },
+
+  getCurrentDateFormatted(): string {
+    const now = new Date();
+    const year = String(now.getFullYear()).padStart(4, '0');
+    const month = String(now.getMonth() + 1).padStart(2, '0'); // 注意月份是从0开始的，所以需要+1
+    const day = String(now.getDate()).padStart(2, '0');
+
+    return `${year}${month}${day}`;
+  },
+
+  getCurrentDateTimeFormatted(formatDay?: boolean): string {
+    const now = new Date();
+    const year = String(now.getFullYear()).padStart(4, '0');
+    const month = String(now.getMonth() + 1).padStart(2, '0'); // 注意月份是从0开始的
+    const day = String(now.getDate()).padStart(2, '0');
+    const hours = String(now.getHours()).padStart(2, '0');
+    if (formatDay) {
+      return `${year}${month}${day}`;
+    }
+    const minutes = String(now.getMinutes()).padStart(2, '0');
+    const seconds = String(now.getSeconds()).padStart(2, '0'); // 添加秒数
+    return `${year}${month}${day}${hours}${minutes}${seconds}`;
+  },
+
+  checkTimeWithNow(dateString: string): number {
+    // 获取当前时间的日期对象和时间戳
+    let currentTimestamp = this.getCurrentTimestamp();
+
+    // 提取年、月、日、时、分、秒的部分
+    const year = parseInt(dateString.substring(0, 4), 10);
+    const month = parseInt(dateString.substring(4, 6), 10) - 1; // 月份是从 0 开始的，所以要减去 1
+    const day = parseInt(dateString.substring(6, 8), 10);
+    const hour = parseInt(dateString.substring(8, 10), 10);
+    const minute = parseInt(dateString.substring(10, 12), 10);
+    const second = parseInt(dateString.substring(12, 14), 10);
+
+    // 创建日期对象并获取时间戳
+    const dateObject = new Date(year, month, day, hour, minute, second);
+    const dateTimestamp = dateObject.getTime();
+
+    // 比较时间戳
+    if (dateTimestamp > currentTimestamp) {
+      return 1;
+    } else if (dateTimestamp < currentTimestamp) {
+      return -1;
+    } else {
+      return 0;
+    }
+  },
+
+  getCurrentTimestamp(): number {
+    const currentDate = new Date();
+    return currentDate.getTime();
+  },
+
+  checkTimeExpire(expireAt?: Date): boolean {
+    if (!expireAt) {
+      return false;
+    }
+    if (expireAt < new Date()) {
+      return true;
+    }
+    return false;
+  },
+
+  dateTime(e: number): string {
+    let old = new Date(e);
+    let now = new Date();
+    //获取old具体时间
+    let d = old.getTime();
+    let h = old.getHours();
+    let m = old.getMinutes();
+    let Y = old.getFullYear();
+    let M = old.getMonth() + 1;
+    let D = old.getDate();
+    //获取now具体时间
+    let nd = now.getTime();
+    let nh = now.getHours();
+    let n = now.getMinutes();
+    let nY = now.getFullYear();
+    let nM = now.getMonth() + 1;
+    let nD = now.getDate();
+
+    //当天的时间
+    if (D === nD && M === nM && Y === nY) {
+      if (h < 10) {
+        h = parseInt('0' + h);
+      }
+      if (m < 10) {
+        m = parseInt('0' + m);
+      }
+      return h + ':' + m;
+    }
+    //昨天时间
+    if (D + 1 === nD && M === nM && Y === nY) {
+      if (h < 10) {
+        h = parseInt('0' + h);
+      }
+      if (m < 10) {
+        m = parseInt('0' + m);
+      }
+      return '昨天 ' + h + ':' + m;
+    } else {
+      //大于两天
+      return Y + '/' + M + '/' + D;
+    }
+  },
+
+  spaceTime(old: number, now: number): string {
+    old = new Date(old).getTime();
+    now = new Date(now).getTime();
+    if (old > now + 1000 * 60 * 5) {
+      return new Date(now).toString();
+    } else {
+      return '';
+    }
+  },
+
+  timeago(dateTime: number): string {
+    var dateTimeStamp = new Date(dateTime).getTime();
+    let result;
+    let minute = 1000 * 60; //把分，时，天，周，半个月，一个月用毫秒表示
+    let hour = minute * 60;
+    let day = hour * 24;
+    let week = day * 7;
+    let halfamonth = day * 15;
+    let month = day * 30;
+    let now = new Date().getTime(); //获取当前时间毫秒
+    let diffValue = now - dateTimeStamp; //时间差
+    if (diffValue < 0) {
+      return '';
+    }
+    let minC = diffValue / minute; //计算时间差的分，时，天，周，月
+    let hourC = diffValue / hour;
+    let dayC = diffValue / day;
+    let weekC = diffValue / week;
+    let monthC = diffValue / month;
+    if (minC >= 1 && minC < 60) {
+      result = ' ' + parseInt(minC.toString()) + '分钟前';
+    } else if (diffValue >= 0 && diffValue <= minute) {
+      result = '刚刚';
+    } else {
+      result = this.formatDate(dateTime);
+    }
+    return result;
+  },
+
+  formatTime(time: number): string {
+    const second = 1000;
+    const minute = second * 60;
+    const hour = minute * 60;
+    const day = hour * 24;
+    const now = new Date().getTime();
+    const diffValue = now - time;
+
+    // 计算差异时间的量级
+    const secondC = diffValue / second;
+    const minC = diffValue / minute;
+    const hourC = diffValue / hour;
+    const dayC = diffValue / day;
+
+    if (dayC >= 1) {
+      return parseInt(dayC.toString()) + '天';
+    } else if (hourC >= 1) {
+      return parseInt(hourC.toString()) + '小时';
+    } else if (minC >= 1) {
+      return parseInt(minC.toString()) + '分钟';
+    } else {
+      return '刚刚';
+    }
+  },
+
+  formatDate(t: number): string {
+    t = t || Date.now();
+    let time = new Date(t);
+    let nowtime = new Date();
+    let str = '';
+    if (
+      time.getMonth() != nowtime.getMonth() ||
+      time.getDate() != nowtime.getDate()
+    ) {
+      str +=
+        time.getMonth() < 9 ? '0' + (time.getMonth() + 1) : time.getMonth() + 1;
+      str += '-';
+      str += time.getDate() < 10 ? '0' + time.getDate() : time.getDate();
+      str += ' ';
+    }
+    str += time.getHours();
+    str += ':';
+    str += time.getMinutes() < 10 ? '0' + time.getMinutes() : time.getMinutes();
+    return str;
+  },
+
+  utcTimeToTargetTime(utcTime: Date, targetTimezone: string, format?: string) {
+    return moment.tz(utcTime, 'UTC').tz(targetTimezone).format(format);
+  },
+};

package/template/packages/utils/tsconfig.build.json

@@ -0,0 +1,17 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "./dist",
+    "rootDir": ".",
+    "noEmit": false,
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "skipLibCheck": true,
+    "types": []
+  },
+  "include": ["*.ts"],
+  "exclude": ["node_modules", "dist", "**/*.test.ts", "**/*.spec.ts"]
+}

package/template/packages/utils/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "extends": "@repo/config/tsconfig",
+  "compilerOptions": {
+    "jsx": "react-jsx",
+    "paths": {
+      "@repo/types": ["../types"],
+      "@repo/config": ["../config"]
+    }
+  },
+  "include": ["**/*.ts"],
+  "exclude": ["node_modules"]
+}
+

package/template/packages/utils/urlencode.util.ts

@@ -0,0 +1,18 @@
+export default {
+  urlsafeBase64Encode(jsonFlags: string): string {
+    const encoded = Buffer.from(jsonFlags).toString('base64');
+    return this.base64ToUrlSafe(encoded);
+  },
+
+  urlSafeBase64Decode(fromStr: string): string {
+    return Buffer.from(this.urlSafeToBase64(fromStr), 'base64').toString();
+  },
+
+  base64ToUrlSafe(v: string): string {
+    return v.replace(/\//g, '_').replace(/\+/g, '-');
+  },
+
+  urlSafeToBase64(v: string): string {
+    return v.replace(/_/g, '/').replace(/-/g, '+');
+  },
+};

package/template/packages/utils/validate.util.ts

@@ -0,0 +1,25 @@
+export default {
+  isBlank(data: any, debug: boolean = false): boolean {
+    if (data == null) return true;
+    if (typeof data === 'string') return data.trim() === '';
+    if (Array.isArray(data)) return data.length === 0;
+    if (typeof data === 'object') return Object.keys(data).length === 0;
+    if (typeof data === 'number') return data === 0;
+    return false;
+  },
+  isNotBlank(data: any): boolean {
+    return !this.isBlank(data);
+  },
+  diffStr(str1: string, str2: string): string {
+    return str2
+      .split('')
+      .filter((char) => !str1.includes(char))
+      .join('');
+  },
+  getRandomInt(min: number, max: number): number {
+    return Math.floor(Math.random() * (max - min + 1)) + Math.ceil(min);
+  },
+  isXinPianChangEmail(email: string): boolean {
+    return email.endsWith('@xinpianchang.com');
+  },
+};

package/template/packages/validators/README.md

@@ -0,0 +1,149 @@
+# @repo/validators - 共享验证
+
+基于 Zod 的前后端共享验证 Schema。
+
+## 安装
+
+```json
+{
+  "dependencies": {
+    "@repo/validators": "workspace:*"
+  }
+}
+```
+
+## 使用
+
+### 前端表单验证
+
+```typescript
+import { userSchema, loginSchema } from '@repo/validators';
+import { useForm } from 'react-hook-form';
+import { zodResolver } from '@hookform/resolvers/zod';
+
+function LoginForm() {
+  const form = useForm({
+    resolver: zodResolver(loginSchema),
+  });
+
+  // ...
+}
+```
+
+### 后端请求验证
+
+```typescript
+import { createUserSchema } from '@repo/validators';
+import { ZodValidationPipe } from '@nestjs/common';
+
+@Post()
+create(@Body(new ZodValidationPipe(createUserSchema)) data: CreateUserDto) {
+  // data 已通过验证
+}
+```
+
+## 验证 Schema
+
+### 用户相关
+
+```typescript
+import { z } from 'zod';
+
+export const userSchema = z.object({
+  id: z.string().uuid(),
+  email: z.string().email(),
+  name: z.string().min(2).max(50),
+  avatar: z.string().url().optional(),
+});
+
+export const loginSchema = z.object({
+  email: z.string().email('请输入有效的邮箱'),
+  password: z.string().min(8, '密码至少8位'),
+});
+
+export const registerSchema = loginSchema.extend({
+  name: z.string().min(2, '名称至少2个字符'),
+  confirmPassword: z.string(),
+}).refine(data => data.password === data.confirmPassword, {
+  message: '两次密码不一致',
+  path: ['confirmPassword'],
+});
+```
+
+### 类型推断
+
+```typescript
+import { z } from 'zod';
+import { userSchema } from '@repo/validators';
+
+// 自动推断类型
+type User = z.infer<typeof userSchema>;
+// => { id: string; email: string; name: string; avatar?: string }
+```
+
+## 添加新 Schema
+
+1. 在 `src/index.ts` 中定义 Schema：
+
+```typescript
+// packages/validators/src/index.ts
+import { z } from 'zod';
+
+// 任务验证
+export const taskSchema = z.object({
+  title: z.string().min(1, '标题不能为空').max(100),
+  description: z.string().max(500).optional(),
+  priority: z.enum(['low', 'medium', 'high']),
+  dueDate: z.string().datetime().optional(),
+});
+
+export const createTaskSchema = taskSchema.omit({ id: true });
+export const updateTaskSchema = taskSchema.partial();
+
+// 导出类型
+export type Task = z.infer<typeof taskSchema>;
+export type CreateTaskInput = z.infer<typeof createTaskSchema>;
+```
+
+## 常用验证模式
+
+### 分页参数
+
+```typescript
+export const paginationSchema = z.object({
+  page: z.coerce.number().int().positive().default(1),
+  pageSize: z.coerce.number().int().min(1).max(100).default(20),
+});
+```
+
+### ID 参数
+
+```typescript
+export const idParamSchema = z.object({
+  id: z.string().uuid('无效的 ID 格式'),
+});
+```
+
+### 时间范围
+
+```typescript
+export const dateRangeSchema = z.object({
+  startDate: z.string().datetime(),
+  endDate: z.string().datetime(),
+}).refine(data => new Date(data.startDate) <= new Date(data.endDate), {
+  message: '开始时间不能晚于结束时间',
+});
+```
+
+## 最佳实践
+
+1. **复用基础 Schema**：使用 `.extend()`, `.pick()`, `.omit()` 复用
+2. **导出类型**：使用 `z.infer<>` 导出对应类型
+3. **国际化消息**：错误消息支持多语言
+4. **前后端一致**：确保前后端使用相同的验证逻辑
+
+## 构建
+
+```bash
+pnpm --filter @repo/validators build
+```

package/template/packages/validators/jest.config.js

@@ -0,0 +1,20 @@
+/** @type {import('jest').Config} */
+module.exports = {
+  displayName: 'validators',
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  roots: ['<rootDir>/src'],
+  testMatch: ['**/__tests__/**/*.test.ts', '**/*.spec.ts'],
+  moduleFileExtensions: ['ts', 'js', 'json'],
+  collectCoverageFrom: ['src/**/*.ts', '!src/**/*.d.ts', '!src/**/index.ts'],
+  coverageDirectory: 'coverage',
+  coverageThreshold: {
+    global: {
+      branches: 50,
+      functions: 50,
+      lines: 50,
+      statements: 50,
+    },
+  },
+  verbose: true,
+};

package/template/packages/validators/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@repo/validators",
+  "version": "0.1.0",
+  "private": true,
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "dev": "tsc -p tsconfig.build.json --watch",
+    "clean": "rimraf dist",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:cov": "jest --coverage"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "dependencies": {
+    "@repo/config": "workspace:*",
+    "zod": "^3.23.0"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.12",
+    "@types/minimatch": "^6.0.0",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.1.3",
+    "typescript": "^5"
+  }
+}