schema-dsl 1.2.4 → 2.0.0

package/examples/conditional-non-object.js

@@ -1,129 +0,0 @@
-/**
- * ConditionalBuilder 非对象类型示例
- *
- * 展示如何直接验证字符串、数组、布尔值等非对象类型
- */
-
-const { dsl, validate } = require('../index');
-
-console.log('========================================');
-console.log('ConditionalBuilder - 非对象类型示例');
-console.log('========================================\n');
-
-// ============================================
-// 示例1：直接验证字符串
-// ============================================
-console.log('【示例1】直接验证字符串');
-console.log('----------------------------');
-
-const stringSchema = dsl.if((data) => typeof data === 'string' && data.includes('@'))
-  .then('email!')
-  .else('string:1-50');
-
-const r1 = validate(stringSchema, 'test@example.com');
-console.log('✅ 邮箱格式:', r1.valid ? '验证通过' : '验证失败');
-
-const r2 = validate(stringSchema, 'just a text');
-console.log('✅ 普通文本:', r2.valid ? '验证通过' : '验证失败');
-
-// ============================================
-// 示例2：直接验证数组
-// ============================================
-console.log('\n【示例2】直接验证数组');
-console.log('----------------------------');
-
-const arraySchema = dsl.if((data) => Array.isArray(data) && data.length > 5)
-  .message('数组最多5个元素');
-
-const r3 = validate(arraySchema, [1, 2, 3]);
-console.log('✅ 3个元素:', r3.valid ? '验证通过' : '验证失败');
-
-const r4 = validate(arraySchema, [1, 2, 3, 4, 5, 6]);
-console.log('❌ 6个元素:', r4.valid ? '验证通过' : '验证失败');
-if (!r4.valid) {
-  console.log('   错误:', r4.errors[0].message);
-}
-
-// ============================================
-// 示例3：直接验证数字
-// ============================================
-console.log('\n【示例3】直接验证数字');
-console.log('----------------------------');
-
-const numberSchema = dsl.if((data) => typeof data === 'number' && data < 0)
-  .message('不允许负数')
-  .else(null); // 不需要额外验证
-
-const r5 = validate(numberSchema, 10);
-console.log('✅ 正数:', r5.valid ? '验证通过' : '验证失败');
-
-const r6 = validate(numberSchema, -5);
-console.log('❌ 负数:', r6.valid ? '验证通过' : '验证失败');
-if (!r6.valid) {
-  console.log('   错误:', r6.errors[0].message);
-}
-
-// ============================================
-// 示例4：字符串类型判断（邮箱或手机号）
-// ============================================
-console.log('\n【示例4】自动识别邮箱或手机号');
-console.log('----------------------------');
-
-const contactSchema = dsl.if((data) => typeof data === 'string' && data.includes('@'))
-  .then('email!')
-  .else('string:11!');
-
-const r7 = validate(contactSchema, 'user@example.com');
-console.log('✅ 邮箱:', r7.valid ? '验证通过' : '验证失败');
-
-const r8 = validate(contactSchema, '13800138000');
-console.log('✅ 手机号:', r8.valid ? '验证通过' : '验证失败');
-
-const r9 = validate(contactSchema, 'invalid');
-console.log('❌ 无效输入:', r9.valid ? '验证通过' : '验证失败');
-if (!r9.valid) {
-  console.log('   错误:', r9.errors[0].message);
-}
-
-// ============================================
-// 示例5：复杂条件组合
-// ============================================
-console.log('\n【示例5】字符串长度 + 内容组合判断');
-console.log('----------------------------');
-
-const complexSchema = dsl.if((data) => typeof data === 'string' && data.length > 20)
-  .and((data) => data.includes('@'))
-  .then('email!')
-  .else('string:1-50');
-
-const r10 = validate(complexSchema, 'short');
-console.log('✅ 短字符串:', r10.valid ? '验证通过' : '验证失败');
-
-const r11 = validate(complexSchema, 'this-is-a-long-email@example.com');
-console.log('✅ 长邮箱:', r11.valid ? '验证通过' : '验证失败');
-
-const r12 = validate(complexSchema, 'this is a very long string without at symbol');
-console.log('✅ 长文本（无@）:', r12.valid ? '验证通过' : '验证失败');
-
-// ============================================
-// 示例6：边界值处理
-// ============================================
-console.log('\n【示例6】边界值处理');
-console.log('----------------------------');
-
-const boundarySchema = dsl.if((data) => data === null || data === undefined || data === '')
-  .message('值不能为空');
-
-const r13 = validate(boundarySchema, 'valid value');
-console.log('✅ 有效值:', r13.valid ? '验证通过' : '验证失败');
-
-const r14 = validate(boundarySchema, '');
-console.log('❌ 空字符串:', r14.valid ? '验证通过' : '验证失败');
-if (!r14.valid) {
-  console.log('   错误:', r14.errors[0].message);
-}
-
-console.log('\n========================================');
-console.log('示例运行完成！');
-console.log('========================================');
-

package/examples/conditional-validate-example.js

@@ -1,321 +0,0 @@
-/**
- * ConditionalBuilder 快捷验证方法示例
- *
- * 展示 .validate() 和 .check() 方法的使用
- */
-
-const { dsl } = require('../index');
-
-console.log('========================================');
-console.log('ConditionalBuilder - 快捷验证方法示例');
-console.log('========================================\n');
-
-// ============================================
-// 示例1：一行代码验证
-// ============================================
-console.log('【示例1】一行代码验证');
-console.log('----------------------------');
-
-const result1 = dsl.if(d => d.age < 18)
-  .message('未成年用户不能注册')
-  .validate({ age: 16 });
-
-console.log('验证未成年用户:', result1.valid ? '✅ 通过' : '❌ 失败');
-if (!result1.valid) {
-  console.log('错误:', result1.errors[0].message);
-}
-
-const result2 = dsl.if(d => d.age < 18)
-  .message('未成年用户不能注册')
-  .validate({ age: 20 });
-
-console.log('验证成年用户:', result2.valid ? '✅ 通过' : '❌ 失败');
-
-// ============================================
-// 示例2：复用验证器
-// ============================================
-console.log('\n【示例2】复用验证器');
-console.log('----------------------------');
-
-const ageValidator = dsl.if(d => d.age < 18).message('未成年用户不能注册');
-
-const users = [
-  { name: '张三', age: 16 },
-  { name: '李四', age: 20 },
-  { name: '王五', age: 17 },
-  { name: '赵六', age: 25 }
-];
-
-users.forEach(user => {
-  const result = ageValidator.validate(user);
-  console.log(`${user.name}(${user.age}岁):`, result.valid ? '✅ 可以注册' : '❌ 不能注册');
-});
-
-// ============================================
-// 示例3：.check() 快速判断
-// ============================================
-console.log('\n【示例3】.check() 快速判断');
-console.log('----------------------------');
-
-const canRegister = dsl.if(d => d.age < 18)
-  .or(d => d.status === 'blocked')
-  .message('不允许注册');
-
-const testUsers = [
-  { name: '用户A', age: 16, status: 'active' },
-  { name: '用户B', age: 20, status: 'blocked' },
-  { name: '用户C', age: 20, status: 'active' }
-];
-
-testUsers.forEach(user => {
-  const isValid = canRegister.check(user);
-  console.log(`${user.name}:`, isValid ? '✅ 允许注册' : '❌ 禁止注册');
-});
-
-// ============================================
-// 示例4：then/else 动态验证
-// ============================================
-console.log('\n【示例4】then/else 动态验证');
-console.log('----------------------------');
-
-const emailValidator = dsl.if(d => d.userType === 'admin')
-  .then('email!')  // 管理员必填
-  .else('email');  // 普通用户可选
-
-// 管理员有邮箱
-const r1 = emailValidator.validate({
-  userType: 'admin',
-  email: 'admin@example.com'
-});
-console.log('管理员有邮箱:', r1.valid ? '✅ 通过' : '❌ 失败');
-
-// 管理员无邮箱
-const r2 = emailValidator.validate({
-  userType: 'admin',
-  email: ''
-});
-console.log('管理员无邮箱:', r2.valid ? '✅ 通过' : '❌ 失败');
-
-// 普通用户无邮箱
-const r3 = emailValidator.validate({
-  userType: 'user',
-  email: ''
-});
-console.log('普通用户无邮箱:', r3.valid ? '✅ 通过' : '❌ 失败');
-
-// ============================================
-// 示例5：非对象类型验证
-// ============================================
-console.log('\n【示例5】非对象类型验证');
-console.log('----------------------------');
-
-// 验证字符串
-const stringValidator = dsl.if(d => typeof d === 'string' && d.includes('@'))
-  .then('email!')
-  .else('string:1-50');
-
-const r4 = stringValidator.validate('test@example.com');
-console.log('邮箱格式:', r4.valid ? '✅ 通过' : '❌ 失败');
-
-const r5 = stringValidator.validate('just a text');
-console.log('普通文本:', r5.valid ? '✅ 通过' : '❌ 失败');
-
-// 验证数组
-const arrayValidator = dsl.if(d => Array.isArray(d) && d.length > 5)
-  .message('数组最多5个元素');
-
-const r6 = arrayValidator.validate([1, 2, 3]);
-console.log('3个元素:', r6.valid ? '✅ 通过' : '❌ 失败');
-
-const r7 = arrayValidator.validate([1, 2, 3, 4, 5, 6]);
-console.log('6个元素:', r7.valid ? '✅ 通过' : '❌ 失败');
-if (!r7.valid) {
-  console.log('错误:', r7.errors[0].message);
-}
-
-// ============================================
-// 示例6：多语言支持
-// ============================================
-console.log('\n【示例6】多语言支持');
-console.log('----------------------------');
-
-const i18nValidator = dsl.if(d => d.age < 18)
-  .message('conditional.underAge');
-
-// 中文
-const r8 = i18nValidator.validate({ age: 16 }, { locale: 'zh-CN' });
-console.log('中文:', r8.valid ? '✅ 通过' : '❌ 失败');
-if (!r8.valid) {
-  console.log('错误:', r8.errors[0].message);
-}
-
-// 英文
-const r9 = i18nValidator.validate({ age: 16 }, { locale: 'en-US' });
-console.log('英文:', r9.valid ? '✅ 通过' : '❌ 失败');
-if (!r9.valid) {
-  console.log('错误:', r9.errors[0].message);
-}
-
-// ============================================
-// 示例7：实际业务场景
-// ============================================
-console.log('\n【示例7】实际业务场景 - 用户注册');
-console.log('----------------------------');
-
-// 创建多个验证器
-const validators = {
-  age: dsl.if(d => d.age < 18)
-    .message('未成年用户不能注册'),
-
-  email: dsl.if(d => d.userType === 'admin')
-    .then('email!')
-    .else('email'),
-
-  phone: dsl.if(d => d.userType === 'vip')
-    .then('string:11!')
-    .else(null)
-};
-
-// 验证用户
-function validateUser(userData) {
-  console.log(`\n验证用户: ${userData.username}`);
-
-  // 年龄检查
-  if (!validators.age.check(userData)) {
-    console.log('❌ 年龄验证失败');
-    return false;
-  }
-
-  // 邮箱检查
-  const emailResult = validators.email.validate(userData);
-  if (!emailResult.valid) {
-    console.log('❌ 邮箱验证失败:', emailResult.errors[0].message);
-    return false;
-  }
-
-  // 手机号检查
-  const phoneResult = validators.phone.validate(userData);
-  if (!phoneResult.valid) {
-    console.log('❌ 手机号验证失败:', phoneResult.errors[0].message);
-    return false;
-  }
-
-  console.log('✅ 所有验证通过');
-  return true;
-}
-
-// 测试数据
-const userData1 = {
-  username: 'admin1',
-  age: 25,
-  userType: 'admin',
-  email: 'admin@example.com'
-};
-
-const userData2 = {
-  username: 'user1',
-  age: 16,
-  userType: 'user',
-  email: ''
-};
-
-validateUser(userData1);
-validateUser(userData2);
-
-// ============================================
-// 示例8：异步验证 - .validateAsync()
-// ============================================
-console.log('\n【示例8】异步验证 - .validateAsync()');
-console.log('----------------------------');
-
-async function asyncRegister() {
-  const ageValidator = dsl.if(d => d.age < 18)
-    .message('未成年用户不能注册');
-
-  // 验证通过
-  try {
-    const data1 = await ageValidator.validateAsync({ age: 20, name: '张三' });
-    console.log('✅ 验证通过:', data1.name);
-  } catch (error) {
-    console.log('❌ 验证失败:', error.message);
-  }
-
-  // 验证失败
-  try {
-    await ageValidator.validateAsync({ age: 16, name: '李四' });
-  } catch (error) {
-    console.log('❌ 验证失败:', error.message);
-  }
-}
-
-asyncRegister();
-
-// ============================================
-// 示例9：断言验证 - .assert()
-// ============================================
-console.log('\n【示例9】断言验证 - .assert()');
-console.log('----------------------------');
-
-function createUser(userData) {
-  try {
-    // 断言验证，失败直接抛错
-    dsl.if(d => d.age < 18)
-      .message('未成年用户不能注册')
-      .assert(userData);
-
-    dsl.if(d => !d.email || d.email.length === 0)
-      .message('邮箱不能为空')
-      .assert(userData);
-
-    console.log(`✅ 用户 ${userData.name} 创建成功`);
-    return { success: true, user: userData };
-  } catch (error) {
-    console.log(`❌ 用户 ${userData.name} 创建失败: ${error.message}`);
-    return { success: false, error: error.message };
-  }
-}
-
-createUser({ name: '张三', age: 20, email: 'zhangsan@example.com' });
-createUser({ name: '李四', age: 16, email: 'lisi@example.com' });
-createUser({ name: '王五', age: 20, email: '' });
-
-// ============================================
-// 示例10：Express 中间件场景（模拟）
-// ============================================
-console.log('\n【示例10】Express 中间件场景（模拟）');
-console.log('----------------------------');
-
-// 模拟 Express 中间件
-async function checkPermission(req, res, next) {
-  try {
-    await dsl.if(d => d.role !== 'admin' && d.role !== 'moderator')
-      .message('权限不足')
-      .validateAsync(req.user);
-
-    console.log('✅ 权限验证通过');
-    next();
-  } catch (error) {
-    console.log('❌ 权限不足:', error.message);
-    res.status = 403;
-    res.error = error.message;
-  }
-}
-
-// 模拟请求
-const mockReq1 = { user: { name: 'admin', role: 'admin' } };
-const mockReq2 = { user: { name: 'user', role: 'user' } };
-const mockRes = { status: 200, error: null };
-const mockNext = () => console.log('   继续处理请求...');
-
-(async () => {
-  console.log('请求1 - 管理员:');
-  await checkPermission(mockReq1, mockRes, mockNext);
-
-  console.log('请求2 - 普通用户:');
-  await checkPermission(mockReq2, mockRes, mockNext);
-})();
-
-console.log('\n========================================');
-console.log('示例运行完成！');
-console.log('========================================');
-

package/examples/custom-extension.js

@@ -1,85 +0,0 @@
-/**
- * 扩展自定义类型示例
- *
- * 演示如何在项目中扩展 SchemaIO 的功能：
- * 1. 扩展 DSL 方法 (DslBuilder.prototype)
- * 2. 添加自定义格式 (Validator.addFormat)
- * 3. 添加自定义关键字 (Validator.addKeyword)
- */
-
-const { dsl, Validator, DslBuilder } = require('../index');
-
-// ========== 1. 扩展 DSL 方法 ==========
-
-// 扩展 .zipCode() 方法
-DslBuilder.prototype.zipCode = function(country = 'cn') {
-  const patterns = {
-    cn: /^[1-9]\d{5}$/,
-    us: /^\d{5}(-\d{4})?$/
-  };
-
-  const pattern = patterns[country];
-  if (!pattern) throw new Error(`Unsupported country: ${country}`);
-
-  return this.pattern(pattern)
-    .messages({ 'pattern': `无效的邮政编码 (${country})` });
-};
-
-// 扩展 .isEven() 方法 (自定义验证逻辑)
-DslBuilder.prototype.isEven = function() {
-  return this.custom(value => {
-    if (typeof value === 'number' && value % 2 !== 0) {
-      return '必须是偶数';
-    }
-  });
-};
-
-// ========== 2. 添加自定义格式 (Validator) ==========
-
-const validator = new Validator();
-
-// 添加 'ipv4-cidr' 格式
-validator.ajv.addFormat('ipv4-cidr', {
-  type: 'string',
-  validate: (ip) => {
-    const parts = ip.split('/');
-    if (parts.length !== 2) return false;
-    const [addr, mask] = parts;
-    // 简单验证 (实际应使用更严谨的正则)
-    return /^\d{1,3}(\.\d{1,3}){3}$/.test(addr) &&
-           Number(mask) >= 0 && Number(mask) <= 32;
-  }
-});
-
-// ========== 3. 使用扩展功能 ==========
-
-const schema = dsl({
-  // 使用扩展的 DSL 方法 (注意：自定义方法需要用 dsl() 包裹，或者手动扩展 String.prototype)
-  zip: dsl('string!').zipCode('cn'),
-  count: dsl('integer!').isEven(),
-
-  // 使用自定义格式 (通过 string 类型 + format)
-  network: 'string'.format('ipv4-cidr')
-});
-
-// ========== 4. 测试验证 ==========
-
-const data = {
-  zip: '123',       // 无效
-  count: 3,         // 无效 (奇数)
-  network: 'invalid' // 无效
-};
-
-const result = validator.validate(schema, data);
-
-console.log('验证结果:', result.valid);
-if (!result.valid) {
-  result.errors.forEach(e => console.log(`- ${e.path}: ${e.message}`));
-}
-
-// 输出预期:
-// - zip: 无效的邮政编码 (cn)
-// - count: 必须是偶数
-// - network: must match format "ipv4-cidr"
-
-

package/examples/dsl-match-example.js

@@ -1,74 +0,0 @@
-/**
- * DSL Match 语法示例 (v2.1.0)
- *
- * 展示如何使用 dsl.match 和 dsl.if 进行条件验证
- */
-
-const { dsl, validate } = require('../index');
-const fs = require('fs');
-
-function log(msg) {
-  console.log(msg);
-  fs.appendFileSync('dsl-match-output.txt', msg + '\n');
-}
-
-log('Start example...');
-
-log('========== DSL Match 语法示例 ==========\n');
-
-// 1. 基本用法：根据类型验证格式
-log('✨ 1. 基本用法');
-
-const contactSchema = dsl({
-  contactType: 'email|phone',
-
-  // 根据 contactType 的值决定 contact 的验证规则
-  contact: dsl.match('contactType', {
-    email: 'email!',
-    phone: 'string:11!',
-    _default: 'string'
-  })
-});
-
-const data1 = { contactType: 'email', contact: 'test@example.com' };
-log('Email验证: ' + (validate(contactSchema, data1).valid ? '✅ 通过' : '❌ 失败'));
-
-const data2 = { contactType: 'phone', contact: '13800138000' };
-log('Phone验证: ' + (validate(contactSchema, data2).valid ? '✅ 通过' : '❌ 失败'));
-
-const data3 = { contactType: 'phone', contact: '123456789012' }; // 12位，超过11
-log('错误验证: ' + (validate(contactSchema, data3).valid ? '✅ 通过' : '❌ 失败'));
-log('');
-
-
-// 2. 处理中文和特殊字符
-log('✨ 2. 中文和特殊字符');
-
-const discountSchema = dsl({
-  level: 'string',
-
-  discount: dsl.match('level', {
-    '普通用户': 'number:0-5',
-    'VIP-1':   'number:0-20',
-    '100':     'number:0-50'
-  })
-});
-
-log('普通用户: ' + validate(discountSchema, { level: '普通用户', discount: 3 }).valid);
-log('VIP-1: ' + validate(discountSchema, { level: 'VIP-1', discount: 15 }).valid);
-log('');
-
-
-// 3. dsl.if 简单条件
-log('✨ 3. dsl.if 简单条件');
-
-const vipSchema = dsl({
-  isVip: 'boolean',
-  // 如果是VIP，折扣0-50，否则0-10
-  discount: dsl.if('isVip', 'number:0-50', 'number:0-10')
-});
-
-log('VIP折扣: ' + validate(vipSchema, { isVip: true, discount: 40 }).valid);
-log('非VIP折扣: ' + validate(vipSchema, { isVip: false, discount: 40 }).valid); // false
-log('');
-