schema-dsl 1.2.4 → 2.0.0

package/examples/user-registration/README.md

@@ -1,156 +0,0 @@
-# 用户注册系统示例
-
-完整的企业级用户注册验证示例，展示 SchemaIO 的所有高级功能。
-
-## 功能展示
-
-- ✅ 错误消息定制
-- ✅ 字段标签
-- ✅ 多语言支持
-- ✅ 异步验证（数据库检查）
-- ✅ 密码强度验证
-- ✅ 字段引用（密码确认）
-- ✅ 自定义验证器
-- ✅ Express路由集成
-
-## 文件结构
-
-```
-examples/user-registration/
-├── README.md          # 本文件
-├── schema.js          # Schema定义
-├── routes.js          # Express路由
-├── database.js        # 模拟数据库
-└── server.js          # 服务器启动
-```
-
-## 快速开始
-
-### 1. 安装依赖
-
-```bash
-npm install express body-parser
-```
-
-### 2. 启动服务器
-
-```bash
-node examples/user-registration/server.js
-```
-
-### 3. 测试API
-
-```bash
-# 成功注册
-curl -X POST http://localhost:3000/api/register \
-  -H "Content-Type: application/json" \
-  -d '{
-    "username": "john_doe",
-    "email": "john@example.com",
-    "password": "Password123",
-    "confirmPassword": "Password123",
-    "phone": "13800138000"
-  }'
-
-# 验证失败（用户名太短）
-curl -X POST http://localhost:3000/api/register \
-  -H "Content-Type: application/json" \
-  -d '{
-    "username": "ab",
-    "email": "john@example.com",
-    "password": "Password123",
-    "confirmPassword": "Password123",
-    "phone": "13800138000"
-  }'
-
-# 密码不一致
-curl -X POST http://localhost:3000/api/register \
-  -H "Content-Type: application/json" \
-  -d '{
-    "username": "john_doe",
-    "email": "john@example.com",
-    "password": "Password123",
-    "confirmPassword": "Different123",
-    "phone": "13800138000"
-  }'
-```
-
-## 多语言测试
-
-```bash
-# 中文错误消息
-curl -X POST http://localhost:3000/api/register \
-  -H "Content-Type: application/json" \
-  -H "Accept-Language: zh-CN" \
-  -d '{ "username": "ab" }'
-
-# 英文错误消息
-curl -X POST http://localhost:3000/api/register \
-  -H "Content-Type: application/json" \
-  -H "Accept-Language: en-US" \
-  -d '{ "username": "ab" }'
-```
-
-## Schema说明
-
-详见 `schema.js` 文件，包含：
-
-- 用户名：3-32字符，字母数字下划线，自动转小写
-- 邮箱：自动转小写，去空格，异步检查重复
-- 密码：8-64字符，必须包含大小写字母和数字
-- 确认密码：必须与密码字段一致
-- 手机号：中国大陆11位，异步检查重复
-
-## 响应格式
-
-### 成功响应
-
-```json
-{
-  "success": true,
-  "data": {
-    "userId": "507f1f77bcf86cd799439011",
-    "username": "john_doe"
-  }
-}
-```
-
-### 验证失败响应
-
-```json
-{
-  "success": false,
-  "code": "VALIDATION_ERROR",
-  "message": "请检查输入信息",
-  "errors": [
-    {
-      "field": "username",
-      "message": "用户名长度不能少于3个字符",
-      "code": "string.min",
-      "context": {
-        "label": "用户名",
-        "limit": 3,
-        "value": "ab"
-      }
-    }
-  ]
-}
-```
-
-## 技术要点
-
-1. **错误消息定制**: 每个字段都有友好的中文错误提示
-2. **字段标签**: 使用 `.label()` 设置字段的友好名称
-3. **异步验证**: 使用 `.custom()` 实现数据库重复检查
-4. **密码确认**: 使用 `.valid(ref('password'))` 引用密码字段
-5. **自动转换**: 使用 `.lowercase()` 和 `.trim()` 自动清洗数据
-6. **多语言**: 根据 `Accept-Language` 头自动切换语言
-
-## 扩展建议
-
-1. 添加验证码验证
-2. 添加邀请码功能
-3. 集成真实数据库（MongoDB/MySQL）
-4. 添加邮箱验证
-5. 添加手机号验证码
-

package/examples/user-registration/routes.js

@@ -1,92 +0,0 @@
-/**
- * Express路由实现
- * 展示如何在实际项目中使用SchemaIO
- */
-
-const express = require('express');
-const { createRegisterSchema, db } = require('./schema');
-
-const router = express.Router();
-
-/**
- * 注册API
- * POST /api/register
- */
-router.post('/register', async (req, res) => {
-  try {
-    // 获取用户语言（从请求头）
-    const userLang = req.headers['accept-language'] || 'zh-CN';
-    const lang = userLang.startsWith('zh') ? 'zh-CN' : 'en-US';
-
-    // 创建Schema
-    const schema = createRegisterSchema(lang);
-
-    // 验证数据（传入整个body作为context用于password确认）
-    const result = await schema.validate(req.body, {
-      abortEarly: false,  // 收集所有错误
-      context: req.body    // 传递上下文给自定义验证器
-    });
-
-    if (!result.isValid) {
-      return res.status(400).json({
-        success: false,
-        code: 'VALIDATION_ERROR',
-        message: lang === 'zh-CN' ? '请检查输入信息' : 'Please check your input',
-        errors: result.errors.map(err => ({
-          field: err.path ? err.path.join('.') : err.context?.key,
-          message: err.message,
-          code: err.type,
-          context: err.context
-        }))
-      });
-    }
-
-    // 创建用户（模拟）
-    const newUser = {
-      id: Date.now().toString(),
-      username: result.data.username,
-      email: result.data.email,
-      phone: result.data.phone,
-      createdAt: new Date().toISOString()
-    };
-
-    db.users.push(newUser);
-
-    // 返回成功
-    res.json({
-      success: true,
-      message: lang === 'zh-CN' ? '注册成功' : 'Registration successful',
-      data: {
-        userId: newUser.id,
-        username: newUser.username
-      }
-    });
-
-  } catch (error) {
-    console.error('注册失败:', error);
-    res.status(500).json({
-      success: false,
-      code: 'SERVER_ERROR',
-      message: '服务器内部错误'
-    });
-  }
-});
-
-/**
- * 获取已注册用户列表（测试用）
- * GET /api/users
- */
-router.get('/users', (req, res) => {
-  res.json({
-    success: true,
-    data: db.users.map(u => ({
-      username: u.username,
-      email: u.email,
-      phone: u.phone
-    }))
-  });
-});
-
-module.exports = router;
-
-

package/examples/user-registration/schema.js

@@ -1,150 +0,0 @@
-/**
- * 用户注册Schema定义 v2.0.1
- *
- * 展示所有高级功能：
- * - ✨ String扩展链式调用
- * - 错误消息定制
- * - 字段标签
- * - 多语言支持
- * - 自定义验证器（异步）
- */
-
-const { dsl } = require('../../index');
-const Locale = require('../../lib/core/Locale');
-
-// 模拟数据库
-const db = {
-  users: [
-    { username: 'admin', email: 'admin@example.com', phone: '13800138000' }
-  ]
-};
-
-/**
- * 检查用户名是否已存在
- */
-async function checkUsernameExists(username) {
-  return new Promise((resolve) => {
-    setTimeout(() => {
-      const exists = db.users.some(u => u.username === username);
-      resolve(exists);
-    }, 100);
-  });
-}
-
-/**
- * 检查邮箱是否已存在
- */
-async function checkEmailExists(email) {
-  return new Promise((resolve) => {
-    setTimeout(() => {
-      const exists = db.users.some(u => u.email === email);
-      resolve(exists);
-    }, 100);
-  });
-}
-
-/**
- * 检查手机号是否已存在
- */
-async function checkPhoneExists(phone) {
-  return new Promise((resolve) => {
-    setTimeout(() => {
-      const exists = db.users.some(u => u.phone === phone);
-      resolve(exists);
-    }, 100);
-  });
-}
-
-/**
- * 注册Schema定义（使用 v2.0.1 String扩展）
- */
-function createRegisterSchema(lang = 'zh-CN') {
-  // 设置语言
-  Locale.setLocale(lang);
-
-  return dsl({
-    // ✨ 用户名：String扩展 + 自定义验证
-    username: 'string:3-32!'
-      .pattern(/^[a-zA-Z0-9_]+$/)
-      .label('用户名')
-      .messages({
-        'min': '{{#label}}长度不能少于{{#limit}}个字符',
-        'max': '{{#label}}长度不能超过{{#limit}}个字符',
-        'pattern': '{{#label}}只能包含字母、数字和下划线'
-      })
-      .custom(async (value) => {
-        const exists = await checkUsernameExists(value);
-        if (exists) {
-          return { error: 'username.exists', message: '用户名已被占用，请换一个试试' };
-        }
-        return true;
-      }),
-
-    // ✨ 邮箱：String扩展 + 异步验证
-    email: 'email!'
-      .label('邮箱地址')
-      .messages({
-        'format.email': '请输入有效的{{#label}}'
-      })
-      .custom(async (value) => {
-        const exists = await checkEmailExists(value);
-        if (exists) {
-          return { error: 'email.exists', message: '该邮箱已被注册' };
-        }
-        return true;
-      }),
-
-    // ✨ 密码：String扩展 + 复杂正则
-    password: 'string:8-64!'
-      .pattern(/^(?=.*[a-z])(?=.*[A-Z])(?=.*\d).+$/)
-      .label('密码')
-      .messages({
-        'min': '{{#label}}长度不能少于{{#limit}}位',
-        'max': '{{#label}}长度不能超过{{#limit}}位',
-        'pattern': '{{#label}}必须包含大小写字母和数字'
-      }),
-
-    // ✨ 确认密码：String扩展
-    confirmPassword: 'string!'
-      .label('确认密码')
-      .messages({
-        'password.mismatch': '两次输入的密码不一致'
-      })
-      .custom((value, context) => {
-        // 临时实现：手动检查password字段
-        if (context && context.password && value !== context.password) {
-          return { error: 'password.mismatch', message: '两次输入的密码不一致' };
-        }
-        return true;
-      })
-      .required(),
-
-    // ✨ 手机号：String扩展 + 异步验证
-    phone: 'string:11!'
-      .pattern(/^1[3-9]\d{9}$/)
-      .label('手机号')
-      .messages({
-        'pattern': '请输入正确的{{#label}}格式'
-      })
-      .custom(async (value) => {
-        const exists = await checkPhoneExists(value);
-        if (exists) {
-          return { error: 'phone.exists', message: '该手机号已被注册' };
-        }
-        return true;
-      }),
-
-    // 简单字段：纯DSL
-    agreeTerms: 'boolean!'
-  });
-}
-
-module.exports = {
-  createRegisterSchema,
-  db,
-  checkUsernameExists,
-  checkEmailExists,
-  checkPhoneExists
-};
-
-

package/examples/user-registration/server.js

@@ -1,74 +0,0 @@
-/**
- * 用户注册服务器
- *
- * 启动方法：node examples/user-registration/server.js
- */
-
-const express = require('express');
-const bodyParser = require('body-parser');
-const routes = require('./routes');
-
-const app = express();
-const PORT = process.env.PORT || 3000;
-
-// 中间件
-app.use(bodyParser.json());
-app.use(bodyParser.urlencoded({ extended: true }));
-
-// 路由
-app.use('/api', routes);
-
-// 首页
-app.get('/', (req, res) => {
-  res.send(`
-    <h1>SchemaIO 用户注册示例</h1>
-    <p>请使用POST请求测试API:</p>
-    <pre>
-POST http://localhost:${PORT}/api/register
-Content-Type: application/json
-Accept-Language: zh-CN
-
-{
-  "username": "john_doe",
-  "email": "john@example.com",
-  "password": "Password123",
-  "confirmPassword": "Password123",
-  "phone": "13800138001",
-  "agreeTerms": true
-}
-    </pre>
-    <p><a href="/api/users">查看已注册用户</a></p>
-  `);
-});
-
-// 错误处理
-app.use((err, req, res, next) => {
-  console.error(err.stack);
-  res.status(500).json({
-    success: false,
-    code: 'SERVER_ERROR',
-    message: '服务器内部错误'
-  });
-});
-
-// 启动服务器
-app.listen(PORT, () => {
-  console.log(`
-========================================
-  用户注册示例服务器已启动
-========================================
-  地址: http://localhost:${PORT}
-  API: http://localhost:${PORT}/api/register
-  
-  测试命令:
-  curl -X POST http://localhost:${PORT}/api/register \\
-    -H "Content-Type: application/json" \\
-    -H "Accept-Language: zh-CN" \\
-    -d '{"username":"test","email":"test@example.com","password":"Password123","confirmPassword":"Password123","phone":"13800138001","agreeTerms":true}'
-========================================
-  `);
-});
-
-module.exports = app;
-
-