schema-dsl 1.2.5 → 2.0.1

package/examples/middleware-usage.js

@@ -1,93 +0,0 @@
-/**
- * 中间件使用示例
- *
- * 演示如何在 Express/Koa 中使用中间件动态配置 Validator
- */
-
-const express = require('express');
-const { dsl, Validator, Locale } = require('../index');
-
-// 确保加载所有语言包
-require('../lib/locales/index');
-
-// 扩展语言包以支持 Label 翻译 (可选)
-Locale.addLocale('zh-CN', {
-  'label.username': '用户名',
-  'label.email': '邮箱',
-  'label.age': '年龄'
-});
-Locale.addLocale('en-US', {
-  'label.username': 'Username',
-  'label.email': 'Email',
-  'label.age': 'Age'
-});
-
-const app = express();
-const validator = new Validator();
-
-// ========== 中间件定义 ==========
-
-/**
- * SchemaIO 验证中间件
- *
- * 1. 从请求头获取语言
- * 2. 创建绑定了语言的 validate 方法
- * 3. 挂载到 req 对象上
- */
-const schemaIoMiddleware = (req, res, next) => {
-  // 获取语言 (支持 accept-language 头或 query 参数)
-  const lang = req.query.lang || req.headers['accept-language'] || 'en-US';
-
-  // 简单的语言匹配逻辑 (例如取前两个字符或完整匹配)
-  // 这里假设完整匹配，实际项目中可能需要更复杂的解析
-  const locale = lang.includes('zh') ? 'zh-CN' :
-                 lang.includes('ja') ? 'ja-JP' :
-                 lang.includes('es') ? 'es-ES' :
-                 lang.includes('fr') ? 'fr-FR' : 'en-US';
-
-  // 挂载 validate 方法
-  req.validate = (schema, data) => {
-    return validator.validate(schema, data, { locale });
-  };
-
-  next();
-};
-
-app.use(schemaIoMiddleware);
-app.use(express.json());
-
-// ========== 路由定义 ==========
-
-const userSchema = dsl({
-  username: 'string:3-32!'.username(), // 自动查找 label.username
-  email: 'email!',                     // 自动查找 label.email
-  age: 'integer:0-150'                 // 自动查找 label.age
-});
-
-app.post('/users', (req, res) => {
-  const result = req.validate(userSchema, req.body);
-
-  if (!result.valid) {
-    return res.status(400).json({
-      error: 'Validation Failed',
-      details: result.errors.map(e => e.message)
-    });
-  }
-
-  res.json({ message: 'User created', data: result.data });
-});
-
-// ========== 启动服务器 (仅用于演示) ==========
-
-if (require.main === module) {
-  const port = 3000;
-  app.listen(port, () => {
-    console.log(`Server running at http://localhost:${port}`);
-    console.log('Try sending POST /users with different Accept-Language headers');
-    console.log('Example: curl -X POST http://localhost:3000/users -H "Content-Type: application/json" -H "Accept-Language: zh-CN" -d "{}"');
-  });
-}
-
-module.exports = app;
-
-

package/examples/new-features-comparison.js

@@ -1,315 +0,0 @@
-/**
- * SchemaIO v2.1.0 新旧 API 对比示例
- *
- * 展示新功能如何简化代码和提升开发体验
- */
-
-const { dsl, validate, validateAsync, ValidationError, SchemaUtils } = require('../index');
-
-console.log('========================================');
-console.log('SchemaIO v2.1.0 新旧 API 对比');
-console.log('========================================\n');
-
-// ==========================================
-// 场景 1：异步验证方法
-// ==========================================
-
-console.log('【场景 1】异步验证方法 - 自动抛出错误\n');
-
-const userSchema = dsl({
-  name: 'string:1-50!',
-  email: 'email!',
-  age: 'integer:18-120'
-});
-
-// --- 旧方法 ---
-console.log('❌ 旧方法（手动检查 valid）：');
-function validateUserOldWay(data) {
-  const result = validate(userSchema, data);
-
-  if (!result.valid) {
-    const errors = result.errors.map(e => e.message).join(', ');
-    throw new Error(`验证失败: ${errors}`);
-  }
-
-  return result.data;
-}
-
-try {
-  validateUserOldWay({ name: '', email: 'invalid' });
-} catch (error) {
-  console.log('  错误:', error.message);
-}
-
-// --- 新方法 ---
-console.log('\n✅ 新方法（自动抛出错误）：');
-async function validateUserNewWay(data) {
-  return await validateAsync(userSchema, data);
-}
-
-(async () => {
-  try {
-    await validateUserNewWay({ name: '', email: 'invalid' });
-  } catch (error) {
-    if (error instanceof ValidationError) {
-      console.log('  错误:', error.message);
-      console.log('  详细:', error.toJSON());
-    }
-  }
-})();
-
-console.log('\n代码行数对比：');
-console.log('  旧方法: 8 行代码');
-console.log('  新方法: 2 行代码（减少 75%）\n');
-
-// ==========================================
-// 场景 2：Express 路由
-// ==========================================
-
-console.log('【场景 2】Express 路由 - 统一错误处理\n');
-
-// --- 旧方法 ---
-console.log('❌ 旧方法（每个路由都要检查）：');
-console.log(`
-app.post('/users', (req, res) => {
-  const result = validate(userSchema, req.body);
-  
-  if (!result.valid) {
-    return res.status(400).json({
-      error: 'Validation Failed',
-      details: result.errors
-    });
-  }
-  
-  // 继续处理...
-});
-`);
-
-// --- 新方法 ---
-console.log('✅ 新方法（统一错误处理）：');
-console.log(`
-// 全局错误处理中间件（只写一次）
-app.use((error, req, res, next) => {
-  if (error instanceof ValidationError) {
-    return res.status(400).json(error.toJSON());
-  }
-  next(error);
-});
-
-// 路由中使用（简洁）
-app.post('/users', async (req, res, next) => {
-  try {
-    const data = await validateAsync(userSchema, req.body);
-    const user = await db.users.insert(data);
-    res.json(user);
-  } catch (error) {
-    next(error);
-  }
-});
-`);
-
-console.log('优势：');
-console.log('  ✓ 错误处理代码减少 60%');
-console.log('  ✓ 统一错误响应格式');
-console.log('  ✓ 代码更易维护\n');
-
-// ==========================================
-// 场景 3：Schema 复用 - 严格验证
-// ==========================================
-
-console.log('【场景 3】Schema 复用 - 处理额外字段\n');
-
-const baseUserSchema = dsl({
-  name: 'string:1-50!',
-  email: 'email!'
-});
-
-const testData = {
-  name: 'John Doe',
-  email: 'john@example.com',
-  avatar: 'https://example.com/avatar.jpg' // 额外字段
-};
-
-// --- 旧方法 ---
-console.log('❌ 旧方法（无法灵活处理额外字段）：');
-const result1 = validate(baseUserSchema, testData);
-console.log('  验证结果:', result1.valid ? '通过' : '失败');
-console.log('  问题: 需要手动筛选字段\n');
-
-// --- 新方法: omit ---
-console.log('✅ 新方法 - omit（排除敏感字段）：');
-const publicSchema = SchemaUtils.omit(baseUserSchema, ['password']);
-const result2 = validate(publicSchema, testData);
-console.log('  验证结果:', result2.valid ? '通过' : '失败');
-console.log('  返回数据（自动移除password）:', result2.data);
-
-// --- 新方法: extend ---
-console.log('\n✅ 新方法 - extend（扩展字段）：');
-const extendedSchema = SchemaUtils.extend(
-  baseUserSchema,
-  { avatar: 'url' }
-);
-const result4 = validate(extendedSchema, testData);
-console.log('  验证结果:', result4.valid ? '通过' : '失败');
-console.log('  avatar 被验证:', result4.data.avatar);
-
-console.log('\n提供的模式：');
-console.log('  1. strict()  - 严格验证，拒绝额外字段');
-console.log('  2. loose()   - 宽松模式，允许额外字段');
-console.log('  3. clean()   - 清理模式，移除额外字段');
-console.log('  4. extend()  - 扩展模式，验证指定字段');
-console.log('  5. partial() - 部分验证，只验证指定字段\n');
-
-// ==========================================
-// 场景 4：CRUD 完整示例
-// ==========================================
-
-console.log('【场景 4】CRUD 完整示例\n');
-
-const fullUserSchema = dsl({
-  id: 'objectId!',
-  name: 'string:1-50!',
-  email: 'email!',
-  password: 'string:8-32!',
-  age: 'integer:0-150',
-  createdAt: 'date',
-  updatedAt: 'date'
-});
-
-// --- 旧方法 ---
-console.log('❌ 旧方法（为每个场景重复定义 Schema）：');
-console.log(`
-// POST /users
-const createUserSchemaOld = dsl({
-  name: 'string:1-50!',
-  email: 'email!',
-  password: 'string:8-32!',
-  age: 'integer:0-150'
-});
-
-// PATCH /users/:id
-const updateUserSchemaOld = dsl({
-  name: 'string:1-50',
-  age: 'integer:0-150'
-});
-
-// GET /users/:id
-const publicUserSchemaOld = dsl({
-  id: 'objectId!',
-  name: 'string:1-50!',
-  email: 'email!',
-  age: 'integer:0-150',
-  createdAt: 'date',
-  updatedAt: 'date'
-});
-
-问题：重复代码多，修改不便
-`);
-
-// --- 新方法 ---
-console.log('✅ 新方法（复用 + 灵活处理）：');
-console.log(`
-// 定义一次
-const fullUserSchema = dsl({ ... });
-
-// POST /users - 排除系统字段
-const createSchema = SchemaUtils.omit(fullUserSchema, ['id', 'createdAt', 'updatedAt']);
-
-// PATCH /users/:id - 部分更新
-const updateSchema = SchemaUtils.partial(fullUserSchema, ['name', 'age']);
-
-// GET /users/:id - 排除敏感字段
-const publicSchema = SchemaUtils.omit(fullUserSchema, ['password']);
-
-优势：
-  ✓ 单一数据源，修改方便
-  ✓ 代码量减少 70%
-  ✓ 灵活的字段处理
-`);
-
-// ==========================================
-// 场景 5：业务逻辑
-// ==========================================
-
-console.log('【场景 5】业务逻辑 - Service 层\n');
-
-// --- 旧方法 ---
-console.log('❌ 旧方法（手动检查）：');
-console.log(`
-class UserService {
-  create(data) {
-    const result = validate(createUserSchema, data);
-    
-    if (!result.valid) {
-      const errors = result.errors.map(e => e.message).join(', ');
-      throw new Error(\`验证失败: \${errors}\`);
-    }
-    
-    return db.users.insert(result.data);
-  }
-  
-  update(id, data) {
-    const result = validate(updateUserSchema, data);
-    
-    if (!result.valid) {
-      const errors = result.errors.map(e => e.message).join(', ');
-      throw new Error(\`验证失败: \${errors}\`);
-    }
-    
-    return db.users.update(id, result.data);
-  }
-}
-`);
-
-// --- 新方法 ---
-console.log('✅ 新方法（自动抛出）：');
-console.log(`
-class UserService {
-  async create(data) {
-    const validData = await validateAsync(createUserSchema, data);
-    return await db.users.insert(validData);
-  }
-  
-  async update(id, data) {
-    const validData = await validateAsync(updateUserSchema, data);
-    return await db.users.update(id, validData);
-  }
-}
-
-优势：
-  ✓ 代码行数减少 60%
-  ✓ 逻辑更清晰
-  ✓ 无需重复错误处理代码
-`);
-
-// ==========================================
-// 总结
-// ==========================================
-
-console.log('\n========================================');
-console.log('总结');
-console.log('========================================\n');
-
-console.log('异步验证方法（validateAsync）：');
-console.log('  ✓ 减少 75% 的验证代码');
-console.log('  ✓ 统一错误处理');
-console.log('  ✓ 更符合异步编程习惯\n');
-
-console.log('灵活的 Schema 复用：');
-console.log('  ✓ 5 种模式覆盖所有场景');
-console.log('  ✓ 代码量减少 70%');
-console.log('  ✓ 单一数据源，易于维护\n');
-
-console.log('迁移成本：');
-console.log('  ✓ 100% 向后兼容');
-console.log('  ✓ 无需修改现有代码');
-console.log('  ✓ 可选择性使用新 API\n');
-
-console.log('========================================\n');
-
-module.exports = {
-  userSchema,
-  baseUserSchema,
-  fullUserSchema
-};
-

package/examples/password-reset/README.md

@@ -1,153 +0,0 @@
-# 密码重置示例
-
-完整的密码重置验证示例，展示 ref() 功能的实际应用。
-
-## 功能展示
-
-- ✅ 字段引用（ref）
-- ✅ 密码强度验证
-- ✅ 密码确认验证
-- ✅ 错误消息定制
-- ✅ 多语言支持
-
-## 文件结构
-
-```
-examples/password-reset/
-├── README.md          # 本文件
-├── schema.js          # Schema定义
-└── test.js            # 测试示例
-```
-
-## Schema定义
-
-```javascript
-const { dsl } = require('schema-dsl');
-const Locale = require('schema-dsl/lib/core/Locale');
-
-// 设置中文
-Locale.setLocale('zh-CN');
-
-const passwordResetSchema = dsl({
-  // 新密码：8-64字符，必须包含大小写字母和数字
-  newPassword: 'string:8-64!'
-    .pattern(/^(?=.*[a-z])(?=.*[A-Z])(?=.*\d).+$/)
-    .label('新密码')
-    .messages({
-      'minLength': '{{#label}}长度不能少于8位',
-      'maxLength': '{{#label}}长度不能超过64位',
-      'pattern': '{{#label}}必须包含大小写字母和数字'
-    }),
-  
-  // 确认密码：必填
-  confirmPassword: 'string:8-64!'
-    .label('确认密码')
-    .custom((value, helpers, { parent }) => {
-      if (value !== parent.newPassword) {
-        return '两次输入的密码不一致';
-      }
-    })
-});
-
-module.exports = passwordResetSchema;
-```
-
-## 使用示例
-
-```javascript
-const passwordResetSchema = require('./schema');
-
-// 成功案例
-const validData = {
-  newPassword: 'Password123',
-  confirmPassword: 'Password123'
-};
-
-const result1 = await passwordResetSchema.validate(validData, {
-  root: validData
-});
-console.log(result1.isValid);  // true
-
-// 失败案例1：密码不一致
-const invalidData1 = {
-  newPassword: 'Password123',
-  confirmPassword: 'Different123'
-};
-
-const result2 = await passwordResetSchema.validate(invalidData1, {
-  root: invalidData1
-});
-console.log(result2.errors[0].message);
-// "两次输入的密码不一致"
-
-// 失败案例2：密码强度不够
-const invalidData2 = {
-  newPassword: 'weak',
-  confirmPassword: 'weak'
-};
-
-const result3 = await passwordResetSchema.validate(invalidData2, {
-  root: invalidData2
-});
-console.log(result3.errors);
-// [
-//   { message: "新密码长度不能少于8位", type: "string.min" },
-//   { message: "新密码必须包含大小写字母和数字", type: "string.pattern" }
-// ]
-```
-
-## Express路由示例
-
-```javascript
-const express = require('express');
-const passwordResetSchema = require('./schema');
-
-const router = express.Router();
-
-router.post('/reset-password', async (req, res) => {
-  const result = await passwordResetSchema.validate(req.body, {
-    root: req.body,
-    abortEarly: false
-  });
-
-  if (!result.isValid) {
-    return res.status(400).json({
-      success: false,
-      errors: result.errors.map(err => ({
-        field: err.path?.join('.') || err.context?.key,
-        message: err.message
-      }))
-    });
-  }
-
-  // 更新密码逻辑...
-  res.json({ success: true, message: '密码重置成功' });
-});
-
-module.exports = router;
-```
-
-## 测试
-
-```bash
-# 安装依赖
-npm install schema-dsl
-
-# 运行测试
-node examples/password-reset/test.js
-```
-
-## 核心要点
-
-1. **ref()功能**: 使用 `ref('newPassword')` 引用新密码字段
-2. **密码强度**: 使用正则表达式验证密码强度
-3. **错误消息**: 自定义友好的中文错误提示
-4. **上下文传递**: 验证时传递 `{ root: data }` 使ref可以解析
-
-## 扩展建议
-
-1. 添加旧密码验证
-2. 添加密码历史检查（不能与最近3次密码相同）
-3. 添加密码强度指示器
-4. 集成验证码验证
-

package/examples/password-reset/schema.js

@@ -1,26 +0,0 @@
-/**
- * 密码重置Schema定义
- * 使用DSL语法定义
- */
-
-const { dsl } = require('../../index');
-const Locale = require('../../lib/core/Locale');
-
-// 设置中文
-Locale.setLocale('zh-CN');
-
-// 使用DSL定义密码重置Schema
-const passwordResetSchema = dsl({
-  // 新密码：8-64字符
-  newPassword: 'string:8-64!',
-
-  // 确认密码：必填
-  confirmPassword: 'string:8-64!'
-});
-
-// 注意：ref功能需要在validate时手动检查
-// 因为DSL目前不直接支持ref，这是一个简化示例
-
-module.exports = passwordResetSchema;
-
-

package/examples/password-reset/test.js

@@ -1,101 +0,0 @@
-/**
- * 密码重置测试示例
- */
-
-const passwordResetSchema = require('./schema');
-
-async function runTests() {
-  console.log('========================================');
-  console.log('  密码重置验证测试');
-  console.log('========================================\n');
-
-  // 测试1：成功案例
-  console.log('【测试1】成功案例');
-  const validData = {
-    newPassword: 'Password123',
-    confirmPassword: 'Password123'
-  };
-
-  const result1 = await passwordResetSchema.validate(validData, {
-    root: validData
-  });
-
-  console.log('数据:', validData);
-  console.log('结果:', result1.isValid ? '✅ 验证通过' : '❌ 验证失败');
-  if (!result1.isValid) {
-    console.log('错误:', result1.errors);
-  }
-  console.log('');
-
-  // 测试2：密码不一致
-  console.log('【测试2】密码不一致');
-  const invalidData1 = {
-    newPassword: 'Password123',
-    confirmPassword: 'Different123'
-  };
-
-  const result2 = await passwordResetSchema.validate(invalidData1, {
-    root: invalidData1,
-    abortEarly: false
-  });
-
-  console.log('数据:', invalidData1);
-  console.log('结果:', result2.isValid ? '✅ 验证通过' : '❌ 验证失败');
-  if (!result2.isValid) {
-    result2.errors.forEach(err => {
-      console.log(`  - ${err.message}`);
-    });
-  }
-  console.log('');
-
-  // 测试3：密码强度不够
-  console.log('【测试3】密码强度不够');
-  const invalidData2 = {
-    newPassword: 'weak',
-    confirmPassword: 'weak'
-  };
-
-  const result3 = await passwordResetSchema.validate(invalidData2, {
-    root: invalidData2,
-    abortEarly: false
-  });
-
-  console.log('数据:', invalidData2);
-  console.log('结果:', result3.isValid ? '✅ 验证通过' : '❌ 验证失败');
-  if (!result3.isValid) {
-    result3.errors.forEach(err => {
-      console.log(`  - ${err.message}`);
-    });
-  }
-  console.log('');
-
-  // 测试4：密码太长
-  console.log('【测试4】密码太长');
-  const invalidData3 = {
-    newPassword: 'A'.repeat(65) + 'a1',
-    confirmPassword: 'A'.repeat(65) + 'a1'
-  };
-
-  const result4 = await passwordResetSchema.validate(invalidData3, {
-    root: invalidData3,
-    abortEarly: false
-  });
-
-  console.log('数据: { newPassword: "' + invalidData3.newPassword.substring(0, 20) + '...", ... }');
-  console.log('结果:', result4.isValid ? '✅ 验证通过' : '❌ 验证失败');
-  if (!result4.isValid) {
-    result4.errors.forEach(err => {
-      console.log(`  - ${err.message}`);
-    });
-  }
-  console.log('');
-
-  console.log('========================================');
-  console.log('  测试完成');
-  console.log('========================================');
-}
-
-// 运行测试
-runTests().catch(console.error);
-
-