schema-dsl 1.0.0 → 1.0.3

package/examples/i18n-full-demo.js

@@ -14,26 +14,24 @@ console.log('========== 多语言配置完整示例 ==========\n');
 // ========================================
 // 步骤 1：应用启动时配置
 // ========================================
-console.log('【步骤 1】配置用户语言包和缓存\n');
+console.log('【步骤 1】配置用户语言包\n');
 
 dsl.config({
-  // 用户语言包配置
+  // 方式 A：从目录加载（推荐用于大型项目）
+  // i18n: path.join(__dirname, 'i18n/dsl')
+
+  // 方式 B：直接传入对象（推荐用于小型项目）
   i18n: {
-    // 方式 A：从目录加载（推荐用于大型项目）
-    // localesPath: path.join(__dirname, 'i18n/labels'),
-
-    // 方式 B：直接传入对象（推荐用于小型项目）
-    locales: {
-      'zh-CN': {
-        // 字段标签
-        'username': '用户名',
-        'email': '邮箱地址',
-        'password': '密码',
-        'age': '年龄',
-        'phone': '手机号',
-
-        // 嵌套字段
-        'address.city': '城市',
+    'zh-CN': {
+      // 字段标签
+      'username': '用户名',
+      'email': '邮箱地址',
+      'password': '密码',
+      'age': '年龄',
+      'phone': '手机号',
+
+      // 嵌套字段
+      'address.city': '城市',
         'address.street': '街道',
 
         // 自定义错误消息
@@ -79,13 +77,6 @@ dsl.config({
         'custom.passwordWeak': 'パスワードが弱すぎます'
       }
     }
-  },
-
-  // 缓存配置（可选，大型项目推荐）
-  cache: {
-    maxSize: 10000,   // 大型项目：1万个 Schema
-    ttl: 7200000      // 2 小时
-  }
 });
 
 console.log('✅ 配置完成\n');

package/examples/schema-utils-chaining.examples.js

@@ -1,13 +1,13 @@
 /**
  * SchemaUtils 核心方法示例
  *
- * 展示 v2.1.0 简化后的核心 4 个方法：
+ * 展示 v1.0.3 简化后的核心 4 个方法：
  * 1. omit() - 排除字段
  * 2. pick() - 保留字段
  * 3. partial() - 部分验证
  * 4. extend() - 扩展字段
  *
- * @version 2.1.0 (简化版)
+ * @version 1.0.3 (简化版)
  * @date 2025-12-29
  */
 

package/examples/slug.examples.js

@@ -0,0 +1,179 @@
+/**
+ * slug 类型验证示例
+ *
+ * slug 用于 URL 友好的字符串，只能包含：
+ * - 小写字母 (a-z)
+ * - 数字 (0-9)
+ * - 连字符 (-)
+ *
+ * 格式规则：
+ * - 必须以字母或数字开头
+ * - 必须以字母或数字结尾
+ * - 中间可以有连字符，但不能连续
+ */
+
+const { dsl, validate } = require('../index');
+
+// ========== 示例 1: 基础用法 ==========
+console.log('\n========== 示例 1: 基础 slug 验证 ==========');
+
+const schema1 = dsl({
+  slug: 'slug!'
+});
+
+console.log('✅ 有效的 slug:');
+console.log('  my-blog-post:', validate(schema1, { slug: 'my-blog-post' }).valid);
+console.log('  hello-world:', validate(schema1, { slug: 'hello-world' }).valid);
+console.log('  post-123:', validate(schema1, { slug: 'post-123' }).valid);
+console.log('  article:', validate(schema1, { slug: 'article' }).valid);
+
+console.log('\n❌ 无效的 slug:');
+console.log('  My-Blog-Post:', validate(schema1, { slug: 'My-Blog-Post' }).valid); // 大写
+console.log('  hello_world:', validate(schema1, { slug: 'hello_world' }).valid);   // 下划线
+console.log('  -hello:', validate(schema1, { slug: '-hello' }).valid);             // 开头连字符
+console.log('  hello-:', validate(schema1, { slug: 'hello-' }).valid);             // 结尾连字符
+console.log('  hello--world:', validate(schema1, { slug: 'hello--world' }).valid); // 连续连字符
+console.log('  hello world:', validate(schema1, { slug: 'hello world' }).valid);   // 空格
+
+// ========== 示例 2: DSL 字符串语法 ==========
+console.log('\n========== 示例 2: DSL 字符串语法 ==========');
+
+const schema2 = dsl({
+  articleSlug: 'slug:3-100!'  // slug + 长度限制
+});
+
+console.log('✅ 3-100字符的 slug:');
+console.log('  abc:', validate(schema2, { articleSlug: 'abc' }).valid);
+console.log('  my-long-article-title-with-many-words:',
+  validate(schema2, { articleSlug: 'my-long-article-title-with-many-words' }).valid);
+
+console.log('\n❌ 长度不符:');
+console.log('  ab:', validate(schema2, { articleSlug: 'ab' }).valid);  // 太短
+
+// ========== 示例 3: 链式调用 ==========
+console.log('\n========== 示例 3: 链式调用 ==========');
+
+const schema3 = dsl({
+  pageSlug: 'string!'.slug().label('页面别名')
+});
+
+console.log('✅ 链式调用验证:');
+console.log('  about-us:', validate(schema3, { pageSlug: 'about-us' }).valid);
+console.log('  contact:', validate(schema3, { pageSlug: 'contact' }).valid);
+
+// ========== 示例 4: 实际应用场景 ==========
+console.log('\n========== 示例 4: 博客文章Schema ==========');
+
+const blogPostSchema = dsl({
+  title: 'string:1-200!',
+  slug: 'slug:3-100!',
+  author: 'string!',
+  content: 'string:10-!',
+  tags: 'array<slug>',  // slug 数组
+  publishedAt: 'datetime'
+});
+
+const validPost = {
+  title: 'Getting Started with Node.js',
+  slug: 'getting-started-with-nodejs',
+  author: 'John Doe',
+  content: 'This is a comprehensive guide to Node.js...',
+  tags: ['nodejs', 'javascript', 'backend'],
+  publishedAt: '2025-12-31T10:00:00Z'
+};
+
+console.log('✅ 有效的博客文章:', validate(blogPostSchema, validPost).valid);
+
+const invalidPost = {
+  title: 'Invalid Post',
+  slug: 'Invalid Slug!',  // ❌ 包含大写和特殊字符
+  author: 'Jane',
+  content: 'Short content',
+  tags: ['Node.js', 'JavaScript'],  // ❌ 标签包含大写
+  publishedAt: '2025-12-31T10:00:00Z'
+};
+
+const result = validate(blogPostSchema, invalidPost);
+console.log('\n❌ 无效的博客文章:', result.valid);
+if (!result.valid) {
+  console.log('错误信息:');
+  result.errors.forEach(err => {
+    console.log(`  - ${err.path}: ${err.message}`);
+  });
+}
+
+// ========== 示例 5: URL 生成应用 ==========
+console.log('\n========== 示例 5: 自动生成 slug ==========');
+
+function generateSlug(title) {
+  return title
+    .toLowerCase()
+    .replace(/[^a-z0-9]+/g, '-')  // 替换非字母数字为连字符
+    .replace(/^-+|-+$/g, '');      // 移除首尾连字符
+}
+
+const titles = [
+  'Hello World!',
+  'Getting Started with Node.js',
+  'Top 10 JavaScript Tips & Tricks',
+  '2025年的技术趋势'
+];
+
+const urlSchema = dsl({ slug: 'slug!' });
+
+console.log('标题 → slug 转换:');
+titles.forEach(title => {
+  const slug = generateSlug(title);
+  const isValid = validate(urlSchema, { slug }).valid;
+  console.log(`  "${title}"`);
+  console.log(`    → "${slug}" ${isValid ? '✅' : '❌'}`);
+});
+
+// ========== 示例 6: 多语言支持 ==========
+console.log('\n========== 示例 6: 多语言错误消息 ==========');
+
+const { Validator } = require('../index');
+const validator = new Validator();
+
+const schema6 = dsl({ slug: 'slug!' });
+
+// 中文
+const resultCN = validator.validate(schema6, { slug: 'Invalid Slug!' }, { locale: 'zh-CN' });
+console.log('中文错误:', resultCN.errors[0]?.message);
+
+// 英文
+const resultEN = validator.validate(schema6, { slug: 'Invalid Slug!' }, { locale: 'en-US' });
+console.log('英文错误:', resultEN.errors[0]?.message);
+
+// 西班牙语
+const resultES = validator.validate(schema6, { slug: 'Invalid Slug!' }, { locale: 'es-ES' });
+console.log('西班牙语错误:', resultES.errors[0]?.message);
+
+// ========== 示例 7: 常见错误 ==========
+console.log('\n========== 示例 7: 常见 slug 错误 ==========');
+
+const testCases = [
+  { slug: 'valid-slug-123', expected: true, reason: '✅ 正确格式' },
+  { slug: 'Valid-Slug', expected: false, reason: '❌ 包含大写字母' },
+  { slug: 'hello_world', expected: false, reason: '❌ 包含下划线' },
+  { slug: 'hello world', expected: false, reason: '❌ 包含空格' },
+  { slug: '-hello', expected: false, reason: '❌ 以连字符开头' },
+  { slug: 'hello-', expected: false, reason: '❌ 以连字符结尾' },
+  { slug: 'hello--world', expected: false, reason: '❌ 连续连字符' },
+  { slug: 'hello.world', expected: false, reason: '❌ 包含点号' },
+  { slug: '123-456', expected: true, reason: '✅ 纯数字+连字符' },
+  { slug: 'a', expected: true, reason: '✅ 单个字母' },
+  { slug: '1', expected: true, reason: '✅ 单个数字' }
+];
+
+const testSchema = dsl({ slug: 'slug!' });
+
+console.log('测试用例:');
+testCases.forEach(({ slug, expected, reason }) => {
+  const result = validate(testSchema, { slug });
+  const passed = result.valid === expected;
+  console.log(`  ${passed ? '✅' : '❌'} "${slug}" - ${reason}`);
+});
+
+console.log('\n========== 所有示例完成 ==========');
+

package/index.d.ts

@@ -1,6 +1,6 @@
-// Type definitions for SchemaIO v2.1.2
-// Project: https://github.com/schema-dsl/schema-dsl
-// Definitions by: SchemaIO Team
+// Type definitions for schema-dsl v1.0.3
+// Project: https://github.com/vextjs/schema-dsl
+// Definitions by: schema-dsl Team
 
 
 declare module 'schema-dsl' {
@@ -130,9 +130,9 @@ declare module 'schema-dsl' {
    * ```
    */
   export interface ErrorMessages {
-    /** 最小长度/最小值错误 (v2.1.2+: 推荐使用min代替minLength) */
+    /** 最小长度/最小值错误 (v1.0.3+: 推荐使用min代替minLength) */
     min?: string;
-    /** 最大长度/最大值错误 (v2.1.2+: 推荐使用max代替maxLength) */
+    /** 最大长度/最大值错误 (v1.0.3+: 推荐使用max代替maxLength) */
     max?: string;
     /** 最小长度错误 (向后兼容，推荐使用min) */
     minLength?: string;

package/index.js

@@ -1,11 +1,11 @@
 /**
- * SchemaIO 2.0 - 主入口文件
+ * schema-dsl - 主入口文件
  *
  * 统一的DSL Builder Pattern
  * 简洁 + 强大 = 完美平衡
  *
  * @module schema-dsl
- * @version 2.0.0
+ * @version 1.0.3
  */
 
 // ========== 核心层 ==========
@@ -35,48 +35,44 @@ dsl.if = dsl.DslAdapter.if;
  * 全局配置
  * @param {Object} options - 配置选项
  * @param {Object} options.patterns - 验证规则扩展 (phone, idCard, creditCard)
- * @param {Object} options.phone - 手机号验证规则扩展 (兼容旧版)
+ * @param {string|Object} options.i18n - 多语言配置（目录路径或语言包对象）
  */
 dsl.config = function (options = {}) {
   const patterns = require('./lib/config/patterns');
 
-  // 兼容旧版 options.phone
-  if (options.phone) {
-    Object.assign(patterns.phone, options.phone);
-  }
-
-  // 新版 options.patterns
+  // patterns 配置
   if (options.patterns) {
     if (options.patterns.phone) Object.assign(patterns.phone, options.patterns.phone);
     if (options.patterns.idCard) Object.assign(patterns.idCard, options.patterns.idCard);
     if (options.patterns.creditCard) Object.assign(patterns.creditCard, options.patterns.creditCard);
   }
 
-  // 多语言支持 (v2.1.0)
-  if (options.locales) {
-    if (typeof options.locales === 'object') {
-      Object.keys(options.locales).forEach(locale => {
-        Locale.addLocale(locale, options.locales[locale]);
-      });
-    } else if (typeof options.locales === 'string') {
-      // 支持传入目录路径
-      try {
-        const fs = require('fs');
-        const path = require('path');
-        if (fs.existsSync(options.locales) && fs.statSync(options.locales).isDirectory()) {
-          const files = fs.readdirSync(options.locales);
-          files.forEach(file => {
-            if (file.endsWith('.js') || file.endsWith('.json')) {
-              const localeName = path.basename(file, path.extname(file));
-              const messages = require(path.resolve(options.locales, file));
-              Locale.addLocale(localeName, messages);
-            }
-          });
-        }
-      } catch (e) {
-        console.warn('[SchemaIO] Failed to load locales from path:', e.message);
+  // 多语言支持 (v1.0.1 优化)
+  if (options.i18n) {
+    // 方式 1: 传入目录路径（字符串）
+    if (typeof options.i18n === 'string') {
+      const fs = require('fs');
+      const path = require('path');
+
+      if (fs.existsSync(options.i18n) && fs.statSync(options.i18n).isDirectory()) {
+        const files = fs.readdirSync(options.i18n);
+        files.forEach(file => {
+          if (file.endsWith('.js') || file.endsWith('.json')) {
+            const localeName = path.basename(file, path.extname(file));
+            const messages = require(path.resolve(options.i18n, file));
+            Locale.addLocale(localeName, messages);
+          }
+        });
+      } else {
+        console.warn('[schema-dsl] i18n path does not exist:', options.i18n);
       }
     }
+    // 方式 2: 直接传入对象
+    else if (typeof options.i18n === 'object') {
+      Object.keys(options.i18n).forEach(locale => {
+        Locale.addLocale(locale, options.i18n[locale]);
+      });
+    }
   }
 };
 
@@ -154,7 +150,7 @@ installStringExtensions(dsl);
  *   }
  * });
  */
-dsl.config = function(options = {}) {
+dsl.config = function (options = {}) {
   // ========== 用户语言包配置 ==========
   if (options.i18n) {
     const { localesPath, locales } = options.i18n;
@@ -276,7 +272,7 @@ module.exports = {
   CONSTANTS,
 
   // 版本信息
-  VERSION: '2.1.0'
+  VERSION: '1.0.3'
 };
 
 

package/lib/config/constants.js

@@ -236,7 +236,7 @@ module.exports = {
     DEFAULT_STYLE: 'joi',
 
     // API版本
-    VERSION: '2.0.0'
+    VERSION: '1.0.3'
   },
 
   // ========== 插件配置 ==========

package/lib/config/patterns/common.js

@@ -0,0 +1,47 @@
+/**
+ * 通用验证模式（v1.0.2新增）
+ *
+ * @module lib/config/patterns/common
+ */
+
+module.exports = {
+  /**
+   * 域名验证
+   * 支持格式: example.com, sub.example.com
+   */
+  domain: {
+    pattern: /^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$/i,
+    key: 'pattern.domain',
+    min: 3,
+    max: 253
+  },
+
+  /**
+   * IP地址验证（IPv4 或 IPv6）
+   * 支持格式: 192.168.1.1, 2001:0db8:85a3::8a2e:0370:7334
+   */
+  ip: {
+    // 同时支持IPv4和IPv6的复合正则
+    pattern: /^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$|^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$/,
+    key: 'pattern.ip'
+  },
+
+  /**
+   * Base64编码验证
+   * 支持标准Base64格式（带或不带padding）
+   */
+  base64: {
+    pattern: /^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$/,
+    key: 'pattern.base64'
+  },
+
+  /**
+   * JWT令牌验证
+   * 支持格式: header.payload.signature
+   */
+  jwt: {
+    pattern: /^[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]*$/,
+    key: 'pattern.jwt'
+  }
+};
+

package/lib/config/patterns/index.js

@@ -4,5 +4,6 @@ module.exports = {
   creditCard: require('./creditCard'),
   licensePlate: require('./licensePlate'),
   postalCode: require('./postalCode'),
-  passport: require('./passport')
+  passport: require('./passport'),
+  common: require('./common')  // v1.0.2新增
 };