schema-dsl 1.0.0 → 1.0.4

package/lib/validators/CustomKeywords.js

@@ -25,6 +25,12 @@ class CustomKeywords {
     this.registerRangeKeyword(ajv);
     this.registerCustomValidatorsKeyword(ajv);
     this.registerMetadataKeywords(ajv);
+    // 新增验证器（v1.0.2）
+    this.registerStringValidators(ajv);
+    this.registerNumberValidators(ajv);
+    this.registerObjectValidators(ajv);
+    this.registerArrayValidators(ajv);
+    this.registerDateValidators(ajv);
   }
 
   /**
@@ -197,6 +203,405 @@ class CustomKeywords {
       errors: true
     });
   }
+
+  /**
+   * 注册 String 类型验证器（v1.0.2新增）
+   * @static
+   * @param {Ajv} ajv - ajv实例
+   */
+  static registerStringValidators(ajv) {
+    // exactLength: 精确长度验证
+    ajv.addKeyword({
+      keyword: 'exactLength',
+      type: 'string',
+      schemaType: 'number',
+      validate: function validate(schema, data) {
+        if (data.length !== schema) {
+          validate.errors = [{
+            keyword: 'exactLength',
+            message: `string.length`,
+            params: { limit: schema }
+          }];
+          return false;
+        }
+        return true;
+      },
+      errors: true
+    });
+
+    // alphanum: 只能包含字母和数字
+    ajv.addKeyword({
+      keyword: 'alphanum',
+      type: 'string',
+      schemaType: 'boolean',
+      validate: function validate(schema, data) {
+        if (schema && !/^[a-zA-Z0-9]*$/.test(data)) {
+          validate.errors = [{
+            keyword: 'alphanum',
+            message: 'string.alphanum',
+            params: {}
+          }];
+          return false;
+        }
+        return true;
+      },
+      errors: true
+    });
+
+    // trim: 不能包含前后空格
+    ajv.addKeyword({
+      keyword: 'trim',
+      type: 'string',
+      schemaType: 'boolean',
+      validate: function validate(schema, data) {
+        if (schema && data !== data.trim()) {
+          validate.errors = [{
+            keyword: 'trim',
+            message: 'string.trim',
+            params: {}
+          }];
+          return false;
+        }
+        return true;
+      },
+      errors: true
+    });
+
+    // lowercase: 必须是小写
+    ajv.addKeyword({
+      keyword: 'lowercase',
+      type: 'string',
+      schemaType: 'boolean',
+      validate: function validate(schema, data) {
+        if (schema && data !== data.toLowerCase()) {
+          validate.errors = [{
+            keyword: 'lowercase',
+            message: 'string.lowercase',
+            params: {}
+          }];
+          return false;
+        }
+        return true;
+      },
+      errors: true
+    });
+
+    // uppercase: 必须是大写
+    ajv.addKeyword({
+      keyword: 'uppercase',
+      type: 'string',
+      schemaType: 'boolean',
+      validate: function validate(schema, data) {
+        if (schema && data !== data.toUpperCase()) {
+          validate.errors = [{
+            keyword: 'uppercase',
+            message: 'string.uppercase',
+            params: {}
+          }];
+          return false;
+        }
+        return true;
+      },
+      errors: true
+    });
+
+    // jsonString: JSON字符串验证
+    ajv.addKeyword({
+      keyword: 'jsonString',
+      type: 'string',
+      schemaType: 'boolean',
+      validate: function validate(schema, data) {
+        if (schema) {
+          try {
+            JSON.parse(data);
+            return true;
+          } catch (error) {
+            validate.errors = [{
+              keyword: 'jsonString',
+              message: 'pattern.json',
+              params: {}
+            }];
+            return false;
+          }
+        }
+        return true;
+      },
+      errors: true
+    });
+  }
+
+  /**
+   * 注册 Number 类型验证器（v1.0.2新增）
+   * @static
+   * @param {Ajv} ajv - ajv实例
+   */
+  static registerNumberValidators(ajv) {
+    // precision: 小数位数限制
+    ajv.addKeyword({
+      keyword: 'precision',
+      type: 'number',
+      schemaType: 'number',
+      validate: function validate(schema, data) {
+        const decimalPart = String(data).split('.')[1];
+        const actualPrecision = decimalPart ? decimalPart.length : 0;
+
+        if (actualPrecision > schema) {
+          validate.errors = [{
+            keyword: 'precision',
+            message: 'number.precision',
+            params: { limit: schema }
+          }];
+          return false;
+        }
+        return true;
+      },
+      errors: true
+    });
+
+    // port: 端口号验证 (1-65535)
+    ajv.addKeyword({
+      keyword: 'port',
+      type: ['integer', 'number'],
+      schemaType: 'boolean',
+      validate: function validate(schema, data) {
+        if (schema && (data < 1 || data > 65535 || !Number.isInteger(data))) {
+          validate.errors = [{
+            keyword: 'port',
+            message: 'number.port',
+            params: {}
+          }];
+          return false;
+        }
+        return true;
+      },
+      errors: true
+    });
+  }
+
+  /**
+   * 注册 Object 类型验证器（v1.0.2新增）
+   * @static
+   * @param {Ajv} ajv - ajv实例
+   */
+  static registerObjectValidators(ajv) {
+    // requiredAll: 要求所有定义的属性都必须存在
+    ajv.addKeyword({
+      keyword: 'requiredAll',
+      type: 'object',
+      schemaType: 'boolean',
+      validate: function validate(schema, data, parentSchema) {
+        if (!schema) return true;
+
+        const properties = parentSchema.properties;
+        if (!properties) return true;
+
+        const missingKeys = Object.keys(properties).filter(key => !(key in data));
+
+        if (missingKeys.length > 0) {
+          validate.errors = [{
+            keyword: 'requiredAll',
+            message: 'object.missing',
+            params: { missing: missingKeys }
+          }];
+          return false;
+        }
+        return true;
+      },
+      errors: true
+    });
+
+    // strictSchema: 严格模式，不允许额外属性
+    ajv.addKeyword({
+      keyword: 'strictSchema',
+      type: 'object',
+      schemaType: 'boolean',
+      validate: function validate(schema, data, parentSchema) {
+        if (!schema) return true;
+
+        const properties = parentSchema.properties || {};
+        const allowedKeys = Object.keys(properties);
+        const extraKeys = Object.keys(data).filter(key => !allowedKeys.includes(key));
+
+        if (extraKeys.length > 0) {
+          validate.errors = [{
+            keyword: 'strictSchema',
+            message: 'object.schema',
+            params: { extra: extraKeys }
+          }];
+          return false;
+        }
+        return true;
+      },
+      errors: true
+    });
+  }
+
+  /**
+   * 注册 Array 类型验证器（v1.0.2新增）
+   * @static
+   * @param {Ajv} ajv - ajv实例
+   */
+  static registerArrayValidators(ajv) {
+    // noSparse: 不允许稀疏数组（undefined元素）
+    ajv.addKeyword({
+      keyword: 'noSparse',
+      type: 'array',
+      schemaType: 'boolean',
+      validate: function validate(schema, data) {
+        if (schema) {
+          for (let i = 0; i < data.length; i++) {
+            if (!(i in data)) {
+              validate.errors = [{
+                keyword: 'noSparse',
+                message: 'array.sparse',
+                params: { index: i }
+              }];
+              return false;
+            }
+          }
+        }
+        return true;
+      },
+      errors: true
+    });
+
+    // includesRequired: 必须包含指定的元素
+    ajv.addKeyword({
+      keyword: 'includesRequired',
+      type: 'array',
+      schemaType: 'array',
+      validate: function validate(schema, data) {
+        if (!Array.isArray(schema) || schema.length === 0) return true;
+
+        const missing = schema.filter(required => {
+          return !data.some(item => {
+            if (typeof required === 'object' && required !== null) {
+              return JSON.stringify(item) === JSON.stringify(required);
+            }
+            return item === required;
+          });
+        });
+
+        if (missing.length > 0) {
+          validate.errors = [{
+            keyword: 'includesRequired',
+            message: 'array.includesRequired',
+            params: { missing }
+          }];
+          return false;
+        }
+        return true;
+      },
+      errors: true
+    });
+  }
+
+  /**
+   * 注册 Date 类型验证器（v1.0.2新增）
+   * @static
+   * @param {Ajv} ajv - ajv实例
+   */
+  static registerDateValidators(ajv) {
+    // dateFormat: 自定义日期格式验证
+    ajv.addKeyword({
+      keyword: 'dateFormat',
+      type: 'string',
+      schemaType: 'string',
+      validate: function validate(schema, data) {
+        // 支持常见格式: YYYY-MM-DD, YYYY/MM/DD, DD-MM-YYYY, DD/MM/YYYY
+        const formats = {
+          'YYYY-MM-DD': /^\d{4}-\d{2}-\d{2}$/,
+          'YYYY/MM/DD': /^\d{4}\/\d{2}\/\d{2}$/,
+          'DD-MM-YYYY': /^\d{2}-\d{2}-\d{4}$/,
+          'DD/MM/YYYY': /^\d{2}\/\d{2}\/\d{4}$/,
+          'ISO8601': /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{3})?Z?$/
+        };
+
+        const pattern = formats[schema];
+        if (!pattern) {
+          validate.errors = [{
+            keyword: 'dateFormat',
+            message: 'date.format',
+            params: { format: schema }
+          }];
+          return false;
+        }
+
+        if (!pattern.test(data)) {
+          validate.errors = [{
+            keyword: 'dateFormat',
+            message: 'date.format',
+            params: { format: schema }
+          }];
+          return false;
+        }
+        return true;
+      },
+      errors: true
+    });
+
+    // dateGreater: 日期必须大于指定日期
+    ajv.addKeyword({
+      keyword: 'dateGreater',
+      type: 'string',
+      schemaType: 'string',
+      validate: function validate(schema, data) {
+        const dataDate = new Date(data);
+        const compareDate = new Date(schema);
+
+        if (isNaN(dataDate.getTime()) || isNaN(compareDate.getTime())) {
+          validate.errors = [{
+            keyword: 'dateGreater',
+            message: 'date.greater',
+            params: { limit: schema }
+          }];
+          return false;
+        }
+
+        if (dataDate <= compareDate) {
+          validate.errors = [{
+            keyword: 'dateGreater',
+            message: 'date.greater',
+            params: { limit: schema }
+          }];
+          return false;
+        }
+        return true;
+      },
+      errors: true
+    });
+
+    // dateLess: 日期必须小于指定日期
+    ajv.addKeyword({
+      keyword: 'dateLess',
+      type: 'string',
+      schemaType: 'string',
+      validate: function validate(schema, data) {
+        const dataDate = new Date(data);
+        const compareDate = new Date(schema);
+
+        if (isNaN(dataDate.getTime()) || isNaN(compareDate.getTime())) {
+          validate.errors = [{
+            keyword: 'dateLess',
+            message: 'date.less',
+            params: { limit: schema }
+          }];
+          return false;
+        }
+
+        if (dataDate >= compareDate) {
+          validate.errors = [{
+            keyword: 'dateLess',
+            message: 'date.less',
+            params: { limit: schema }
+          }];
+          return false;
+        }
+        return true;
+      },
+      errors: true
+    });
+  }
 }
 
 module.exports = CustomKeywords;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "schema-dsl",
-  "version": "1.0.0",
+  "version": "1.0.4",
   "description": "简洁强大的JSON Schema验证库 - DSL语法 + String扩展 + 便捷validate",
   "main": "index.js",
   "exports": {

package/.github/CODE_OF_CONDUCT.md

@@ -1,45 +0,0 @@
-# 贡献者行为准则
-
-## 我们的承诺
-
-为了营造一个开放和友好的环境，我们作为贡献者和维护者承诺：无论年龄、体型、残疾、民族、性别认同和表达、经验水平、教育程度、社会经济地位、国籍、个人形象、种族、宗教或性取向如何，参与我们的项目和社区的每个人都能获得无骚扰的体验。
-
-## 我们的标准
-
-有助于创建积极环境的行为包括：
-
-* 使用友好和包容的语言
-* 尊重不同的观点和经验
-* 优雅地接受建设性批评
-* 关注对社区最有利的事情
-* 对其他社区成员表示同理心
-
-不可接受的行为包括：
-
-* 使用性化的语言或图像，以及不受欢迎的性关注或性骚扰
-* 恶意评论、侮辱/贬损性评论以及人身或政治攻击
-* 公开或私下骚扰
-* 未经明确许可，发布他人的私人信息，如物理地址或电子邮件地址
-* 在专业环境中可能被合理认为不适当的其他行为
-
-## 我们的责任
-
-项目维护者有责任明确可接受行为的标准，并对任何不可接受的行为采取适当和公平的纠正措施。
-
-项目维护者有权删除、编辑或拒绝与本行为准则不符的评论、提交、代码、wiki 编辑、问题和其他贡献，或暂时或永久禁止任何贡献者的其他行为，如果他们认为这些行为不适当、威胁、冒犯或有害。
-
-## 范围
-
-当个人代表项目或其社区时，本行为准则适用于项目空间和公共空间。代表项目或社区的示例包括使用官方项目电子邮件地址、通过官方社交媒体帐户发布信息，或在线上或线下活动中担任指定代表。项目的代表可以由项目维护者进一步定义和澄清。
-
-## 执行
-
-可以通过联系项目团队 rockyshi1993@gmail.com 报告滥用、骚扰或其他不可接受的行为。所有投诉都将被审查和调查，并将做出被认为必要和适当的回应。项目团队有义务对事件报告者保密。具体执行政策的更多细节可能会单独发布。
-
-不善意遵守或执行行为准则的项目维护者可能会面临项目领导层其他成员确定的临时或永久后果。
-
-## 归属
-
-本行为准则改编自 [Contributor Covenant](https://www.contributor-covenant.org) 版本 2.0，可在 https://www.contributor-covenant.org/version/2/0/code_of_conduct.html 获得。
-
-如有关于本行为准则的问题，请参阅 https://www.contributor-covenant.org/faq

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,57 +0,0 @@
----
-name: 🐛 Bug 报告
-about: 报告一个问题帮助我们改进
-title: '[BUG] '
-labels: 'bug'
-assignees: ''
----
-
-## 🐛 Bug 描述
-
-请清晰简洁地描述遇到的问题。
-
-## 🔄 重现步骤
-
-1. 执行 '...'
-2. 调用 '....'
-3. 看到错误 '....'
-
-## ✅ 期望行为
-
-描述你期望发生什么。
-
-## ❌ 实际行为
-
-描述实际发生了什么。
-
-## 📝 代码示例
-
-```javascript
-const { dsl, validate } = require('schema-dsl');
-
-const schema = dsl({
-  // 你的 schema 定义
-});
-
-const result = validate(schema, {
-  // 你的测试数据
-});
-```
-
-## 🌍 环境信息
-
-- **schema-dsl 版本**: [例如 v2.3.0]
-- **Node.js 版本**: [例如 v18.0.0]
-- **操作系统**: [例如 Windows 11 / macOS 14 / Ubuntu 22.04]
-- **包管理器**: [npm / yarn / pnpm]
-
-## 📎 附加信息
-
-添加任何其他有助于解释问题的信息（截图、错误日志等）。
-
-## ✔️ 检查清单
-
-- [ ] 我已搜索现有 Issues，未发现重复问题
-- [ ] 我已阅读 [文档](https://github.com/vextjs/schema-dsl#readme)
-- [ ] 我已提供完整的重现步骤
-- [ ] 我已提供环境信息

package/.github/ISSUE_TEMPLATE/config.yml

@@ -1,11 +0,0 @@
-blank_issues_enabled: false
-contact_links:
-  - name: 📖 查看文档
-    url: https://github.com/vextjs/schema-dsl#readme
-    about: 查看完整文档和示例
-  - name: 💬 讨论区
-    url: https://github.com/vextjs/schema-dsl/discussions
-    about: 提问、分享想法或参与讨论
-  - name: 📝 常见问题
-    url: https://github.com/vextjs/schema-dsl/blob/main/docs/faq.md
-    about: 查看常见问题解答

package/.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,45 +0,0 @@
----
-name: ✨ 功能请求
-about: 建议新功能或改进
-title: '[FEATURE] '
-labels: 'enhancement'
-assignees: ''
----
-
-## ✨ 功能描述
-
-清晰简洁地描述你希望添加的功能。
-
-## 🎯 使用场景
-
-**遇到的问题**:  
-描述你遇到的问题或限制（例如："我总是需要..."或"无法实现..."）
-
-**期望的解决方案**:  
-描述你希望如何解决这个问题。
-
-## 💡 API 设计建议（可选）
-
-如果可以，提供你期望的 API 设计：
-
-```javascript
-const schema = dsl({
-  // 期望的用法示例
-});
-```
-
-## 🔄 替代方案（可选）
-
-描述你考虑过的其他替代方案或功能。
-
-## 📚 参考资料（可选）
-
-- 其他库的类似功能
-- 相关文档或讨论链接
-- 截图或示意图
-
-## ✔️ 检查清单
-
-- [ ] 我已搜索现有 Issues，未发现相同的功能请求
-- [ ] 这个功能符合 SchemaIO 的设计理念（简洁、灵活、易用）
-- [ ] 我愿意提交 PR 来实现这个功能（可选）

package/.github/ISSUE_TEMPLATE/question.md

@@ -1,31 +0,0 @@
----
-name: ❓ 问题咨询
-about: 询问使用问题或获取帮助
-title: '[QUESTION] '
-labels: 'question'
-assignees: ''
----
-
-## ❓ 你的问题
-
-清晰描述你的问题。
-
-## 🔍 你已经尝试过什么
-
-- [ ] 我已查看 [文档](https://github.com/vextjs/schema-dsl#readme)
-- [ ] 我已查看 [FAQ](https://github.com/vextjs/schema-dsl/blob/main/docs/faq.md)
-- [ ] 我已搜索现有 Issues
-
-## 📝 代码示例（可选）
-
-```javascript
-// 你当前的代码
-```
-
-## 🎯 你想实现什么
-
-描述你的目标或期望的效果。
-
-## 📚 相关文档
-
-如果你参考了某些文档但仍有疑问，请提供链接。

package/.github/PULL_REQUEST_TEMPLATE.md

@@ -1,70 +0,0 @@
-# Pull Request
-
-## 📝 描述
-
-请简要描述这个 PR 的目的和改动内容。
-
-## 🔗 关联 Issue
-
-关闭 #(issue编号)
-
-## 🎯 改动类型
-
-请勾选此 PR 的类型：
-
-- [ ] 🐛 Bug 修复
-- [ ] ✨ 新功能
-- [ ] 📚 文档更新
-- [ ] 🎨 代码风格/格式化
-- [ ] ♻️ 重构
-- [ ] ⚡ 性能优化
-- [ ] ✅ 测试相关
-- [ ] 🔧 构建/工具配置
-
-## 💡 改动详情
-
-### 主要改动
-
-- 改动点 1
-- 改动点 2
-
-### 技术细节（可选）
-
-描述技术实现细节。
-
-## 🧪 测试
-
-请描述你如何测试这些改动：
-
-- [ ] 单元测试通过
-- [ ] 集成测试通过
-- [ ] 手动测试场景：
-
-```javascript
-// 测试代码示例
-```
-
-## 📸 截图（如适用）
-
-如果是 UI 相关或有视觉效果的改动，请提供截图。
-
-## ✔️ 检查清单
-
-在提交前请确认：
-
-- [ ] 我的代码遵循项目的代码规范
-- [ ] 我已进行自我审查
-- [ ] 我已添加必要的注释（特别是复杂的逻辑）
-- [ ] 我已更新相关文档
-- [ ] 我的改动没有产生新的警告
-- [ ] 我已添加测试证明我的修复有效或功能正常
-- [ ] 新增和现有的单元测试都通过
-- [ ] 我已更新 CHANGELOG.md（如适用）
-
-## 🤔 其他信息
-
-添加任何其他相关信息。
-
----
-
-感谢你的贡献！ ❤️