schema-dsl 1.0.0 → 1.0.4

package/STATUS.md

@@ -1,19 +1,152 @@
 # schema-dsl 项目状态
 
-> **最后更新**: 2025-12-29  
-> **当前版本**: v1.0.0  
+> **最后更新**: 2025-12-31  
+> **当前版本**: v1.0.4  
 > **项目状态**: ✅ 全部完成，测试100%通过  
 
 ---
 
 ## 📋 目录
 
+- [v1.0.4](#v104) - 2025-12-31 ✅ 已完成
+- [v1.0.3](#v103) - 2025-12-31 ⚠️ 破坏性变更
+- [v1.0.2](#v102) - 2025-12-31 ✅ 已完成
+- [v1.0.1](#v101) - 2025-12-31 ✅ 已完成
 - [v1.0.0](#v100) - 2025-12-29 ✅ 已完成
 
 ---
 
 ## 版本发布计划
 
+### v1.0.4
+
+**发布日期**: 2025-12-31  
+**状态**: ✅ 已完成  
+**类型**: ✨ 功能增强（TypeScript 完整支持）  
+**进度**: 100%完成 | 新增: TypeScript 类型定义、使用指南 | 文档: 1500+ 行
+
+| 需求标题 | 状态 | 优先级 | 详细 |
+|---------|------|--------|------|
+| 完善 index.d.ts | ✅ 完成 | P0 | validateAsync、ValidationError 类型 |
+| String 扩展 TS 说明 | ✅ 完成 | P0 | 添加详细使用说明和对比 |
+| TypeScript 使用指南 | ✅ 完成 | P0 | 1000+ 行完整文档 |
+| README 更新 | ✅ 完成 | P0 | 添加 TypeScript 章节 |
+| 类型错误修复 | ✅ 完成 | P0 | 修复 dsl.config i18n 类型 |
+| 发版文档更新 | ✅ 完成 | P0 | CHANGELOG、STATUS、package.json |
+
+**实现状态统计**:
+- ✅ 完成: 6个
+- 🔄 进行中: 0个
+- ⏳ 待完成: 0个
+
+**核心变更**:
+- ✅ **新增**: validateAsync 函数完整类型定义
+- ✅ **新增**: ValidationError 类完整类型（含所有方法）
+- ✅ **优化**: String 扩展添加 TypeScript 使用说明
+- ✅ **新增**: TypeScript 使用指南文档（1000+ 行）
+- ✅ **修复**: dsl.config 的 i18n 参数类型错误
+- ✅ **文档**: README 添加 TypeScript 快速开始章节
+
+**用户价值**:
+- 🎯 TypeScript 用户获得完整的类型安全和 IDE 提示
+- 🎯 详细的文档指导如何在 TypeScript 中正确使用
+- 🎯 JavaScript 用户体验不变，100% 向后兼容
+- 🎯 降低学习成本，提高开发效率
+
+---
+
+### v1.0.3
+
+**发布日期**: 2025-12-31  
+**状态**: ✅ 已完成  
+**类型**: ⚠️ 破坏性变更  
+**进度**: 100%完成 | 修复: String单值语法 | 测试: 3个新增测试
+
+| 需求标题 | 状态 | 优先级 | 详细 |
+|---------|------|--------|------|
+| String单值语法修复 | ✅ 完成 | P0 | 'string:N' 改为精确长度 |
+| 核心代码修改 | ✅ 完成 | P0 | DslBuilder.js |
+| 测试用例更新 | ✅ 完成 | P0 | 2个修改 + 1个新增 |
+| 文档更新 | ✅ 完成 | P0 | README + CHANGELOG |
+| 迁移指南 | ✅ 完成 | P0 | CHANGELOG 破坏性变更说明 |
+| 新增链式方法 | ✅ 完成 | P1 | dateGreater, dateLess |
+
+**实现状态统计**:
+- ✅ 完成: 6个
+- 🔄 进行中: 0个
+- ⏳ 待完成: 0个
+
+**核心变更**:
+- ⚠️ **破坏性**: `'string:N'` → exactLength: N（之前是 maxLength: N）
+- ✅ **新增**: `'string:-N'` → maxLength: N（明确语法）
+- ✅ **保持**: Number 单值仍为 maximum（无变更）
+- ✅ **新增**: dateGreater() 和 dateLess() 链式方法
+
+---
+
+### v1.0.2
+
+**发布日期**: 2025-12-31  
+**状态**: ✅ 已完成  
+**进度**: 100%完成 | 新增: 15个验证器 | 测试: 75个新增测试
+
+| 需求标题 | 状态 | 优先级 | 详细 |
+|---------|------|--------|------|
+| String验证器扩展 | ✅ 完成 | P1 | 6个新增验证器 |
+| Number验证器扩展 | ✅ 完成 | P1 | 2个新增验证器 |
+| Object验证器扩展 | ✅ 完成 | P1 | 2个新增验证器 |
+| Array验证器扩展 | ✅ 完成 | P1 | 2个新增验证器 |
+| Date验证器扩展 | ✅ 完成 | P1 | 3个新增验证器 |
+| 多语言支持 | ✅ 完成 | P0 | 中英文19个消息 |
+| 文档补充 | ✅ 完成 | P0 | 15个验证器文档 |
+| 示例代码 | ⏳ 待完成 | P1 | 演示新增功能 |
+| 单元测试 | ✅ 完成 | P0 | 75个测试用例 |
+
+**实现状态统计**:
+- ✅ 完成: 8个
+- 🔄 进行中: 0个
+- ⏳ 待完成: 1个
+
+**核心功能**:
+- ✨ **String验证器**: exactLength, alphanum, trim, lowercase, uppercase, jsonString
+- 🔢 **Number验证器**: precision, port
+- 📦 **Object验证器**: requiredAll, strictSchema
+- 📋 **Array验证器**: noSparse, includesRequired
+- 📅 **Date验证器**: dateFormat, dateGreater, dateLess
+- 🌍 **多语言支持**: 中英文各19个新增消息
+- 📝 **完整文档**: validation-rules-v1.0.2.md（1200行）
+- 🧪 **测试覆盖**: 75个测试用例，100%通过
+
+### v1.0.1
+
+**发布日期**: 2025-12-31  
+**状态**: ✅ 已完成  
+**进度**: 100%完成 | 新增: 枚举功能 | 测试: 30个新增测试
+
+| 需求标题 | 状态 | 优先级 | 详细 |
+|---------|------|--------|------|
+| 枚举语法支持 | ✅ 完成 | P0 | value1\|value2 简写语法 |
+| 枚举类型自动识别 | ✅ 完成 | P0 | 字符串/布尔值/数字自动识别 |
+| 枚举显式类型 | ✅ 完成 | P1 | enum:type:values 语法 |
+| 布尔值枚举 | ✅ 完成 | P0 | true\|false 自动识别 |
+| 数字枚举 | ✅ 完成 | P0 | 1\|2\|3 自动识别 |
+| 整数枚举 | ✅ 完成 | P1 | enum:integer:values |
+| 枚举必填标记 | ✅ 完成 | P0 | value1\|value2! |
+| 枚举错误消息 | ✅ 完成 | P0 | 统一使用 'enum' 键 |
+| 枚举文档 | ✅ 完成 | P0 | docs/enum.md 完整文档 |
+| 枚举示例 | ✅ 完成 | P1 | examples/enum.examples.js |
+| 枚举测试 | ✅ 完成 | P0 | 30个测试用例 |
+
+**实现状态统计**:
+- ✅ 完成: 11个
+- 🔄 进行中: 0个
+- ⏳ 待完成: 0个
+
+**核心功能**:
+- ✨ **枚举支持**: 'active|inactive', '1|2|3', 'true|false' 自动识别类型
+- 🎯 **简洁语法**: 统一使用 'enum' 键定义错误消息
+- 🔧 **灵活配置**: 支持显式指定类型 enum:type:values
+
 ### v1.0.0
 
 **发布日期**: 2025-12-29  

package/docs/INDEX.md

@@ -190,7 +190,7 @@
 
 | 文件 | 说明 |
 |------|------|
-| [joi-style.js](../examples/joi-style.js) | Joi 风格完整示例 |
+| [simple-example.js](../examples/simple-example.js) | 简单示例 |
 | [dsl-style.js](../examples/dsl-style.js) | DSL 风格完整示例 |
 | [string-extensions.js](../examples/string-extensions.js) | String 扩展示例 |
 | [password-reset/](../examples/password-reset/) | 密码重置表单示例 |
@@ -217,7 +217,6 @@
 | 文档 | 说明 |
 |------|------|
 | [CONTRIBUTING.md](../CONTRIBUTING.md) | 贡献指南 |
-| [DOCUMENTATION-ISSUES.md](../DOCUMENTATION-ISSUES.md) | 文档审核报告 |
 
 ---
 

package/docs/api-reference.md

@@ -337,298 +337,7 @@ dsl.if('isVip', 'number:0-50', 'number:0-10')
 
 ---
 
-## DslBuilder 类
-
-### 描述
-
-Schema 构建器类，支持链式调用添加验证规则。
-
-### 构造函数
-
-```javascript
-new DslBuilder(dslString: string)
-```
-
-**参数**:
-- `dslString` (**string**) - DSL字符串，如 `'string:3-32!'`
-
-### 方法
-
-#### `.pattern(regex, message?)`
-
-添加正则表达式验证。
-
-**参数**:
-- `regex` (**RegExp** | **string**) - 正则表达式
-- `message` (**string**, 可选) - 自定义错误消息
-
-**返回**: **DslBuilder**
-
-**示例**:
-```javascript
-dsl('string:3-32!')
-  .pattern(/^[a-zA-Z0-9_]+$/, '只能包含字母、数字和下划线')
-```
-
----
-
-#### `.label(text)`
-
-设置字段标签（用于错误消息）。
-
-**参数**:
-- `text` (**string**) - 标签文本
-
-**返回**: **DslBuilder**
-
-**示例**:
-```javascript
-dsl('email!').label('邮箱地址')
-```
-
----
-
-#### `.messages(messages)`
-
-自定义错误消息。
-
-**参数**:
-- `messages` (**Object**) - 错误消息对象
-  - 键：错误代码（如 `'string.min'`）
-  - 值：错误消息模板
-
-**返回**: **DslBuilder**
-
-**示例**:
-```javascript
-dsl('string:3-32!')
-  .messages({
-    'string.min': '至少{{#limit}}个字符',
-    'string.max': '最多{{#limit}}个字符'
-  })
-```
-
----
-
-#### `.description(text)`
-
-设置字段描述。
-
-**参数**:
-- `text` (**string**) - 描述文本
-
-**返回**: **DslBuilder**
-
-**示例**:
-```javascript
-dsl('url').description('个人主页链接')
-```
-
----
-
-#### `.custom(validator)`
-
-添加自定义验证器。
-
-**参数**:
-- `validator` (**Function**) - 验证函数
-  - 签名：`(value) => boolean | Promise<boolean> | { error, message }`
-  - 返回 `true` 表示通过
-  - 返回 `false` 或错误对象表示失败
-
-**返回**: **DslBuilder**
-
-**示例**:
-```javascript
-dsl('string:3-32!')
-  .custom(async (value) => {
-    const exists = await checkUsernameExists(value);
-    if (exists) {
-      return { error: 'username.exists', message: '用户名已存在' };
-    }
-    return true;
-  })
-```
-
----
-
-#### `.default(value)`
-
-设置默认值。
-
-**参数**:
-- `value` (**any**) - 默认值
-
-**返回**: **DslBuilder**
-
-**示例**:
-```javascript
-dsl('string').default('guest')
-```
-
----
-
-#### `.username(preset?)`
-
-用户名验证（自动设置长度和正则）。
-
-**参数**:
-- `preset` (**string** | **Object**, 可选) - 预设配置
-  - 字符串：`'short'` | `'medium'` | `'long'` | `'5-20'`
-  - 对象：`{ minLength, maxLength, allowUnderscore, allowNumber }`
-  - 默认值：`'medium'` (3-32位)
-
-**返回**: **DslBuilder**
-
-**示例**:
-```javascript
-// 默认 medium (3-32位)
-dsl('string!').username()
-
-// 自定义范围
-dsl('string!').username('5-20')
-
-// 使用预设
-dsl('string!').username('short')  // 3-16位
-```
-
----
-
-#### `.password(strength?)`
-
-密码强度验证（自动设置长度和正则）。
-
-**参数**:
-- `strength` (**string**, 可选) - 强度级别
-  - `'weak'` - 最少6位
-  - `'medium'` - 8位，字母+数字（默认）
-  - `'strong'` - 8位，大小写+数字
-  - `'veryStrong'` - 10位，大小写+数字+特殊字符
-
-**返回**: **DslBuilder**
-
-**示例**:
-```javascript
-dsl('string!').password('strong')
-```
-
----
-
-#### `.phone(country?)`
-
-手机号验证（自动设置长度和正则）。
-
-**参数**:
-- `country` (**string**, 可选) - 国家代码
-  - `'cn'` - 中国（默认）
-  - `'us'` - 美国
-  - `'uk'` - 英国
-  - `'hk'` - 香港
-  - `'tw'` - 台湾
-  - `'international'` - 国际格式
-
-**返回**: **DslBuilder**
-
-**注意**: 自动将类型纠正为 `string`（即使写成 `number` 也会自动修正）
-
-**示例**:
-```javascript
-// 推荐写法
-dsl('string!').phone('cn')
-
-// 自动纠正：number → string
-dsl('number!').phone('cn')  // 自动纠正为 string
-```
-
----
-
-#### `.toSchema()`
-
-转换为 JSON Schema 对象。
-
-**返回**: **Object** - JSON Schema对象
-
-**示例**:
-```javascript
-const schema = dsl('email!').label('邮箱').toSchema();
-// { type: 'string', format: 'email', _label: '邮箱', _required: true }
-```
-
----
-
-#### `.validate(data, context?)`
-
-验证数据（便捷方法）。
-
-**参数**:
-- `data` (**any**) - 待验证数据
-- `context` (**Object**, 可选) - 验证上下文
-
-**返回**: **Promise<Object>** - 验证结果
-  - `valid` (**boolean**) - 是否通过
-  - `errors` (**Array**, 可选) - 错误列表
-  - `data` (**any**, 可选) - 验证通过的数据
-
-**示例**:
-```javascript
-const result = await dsl('email!').validate('user@example.com');
-console.log(result.valid); // true
-```
-
----
-
-### 静态方法 
-
-#### `dsl.match(field, map)```
-
-创建条件验证规则（类似 switch-case）。
-
-**参数**:
-- `field` (**string**) - 依赖的字段名
-- `map` (**Object**) - 值与Schema的映射
-  - `[value: string]`: 对应的Schema
-  - `_default` (**optional**): 默认Schema
-
-**返回**: **Object** - 内部Match结构
-
-**示例**:
-```javascript
-dsl.match('type', {
-  email: 'email!',
-  phone: 'string:11!',
-  _default: 'string'
-})
-```
-
-#### `dsl.if(condition, thenSchema, elseSchema)`
-
-创建简单的条件验证规则。
-
-**参数**:
-- `condition` (**string**) - 条件字段名
-- `thenSchema` (**string|Object**) - 满足条件时的Schema
-- `elseSchema` (**string|Object**, 可选) - 不满足条件时的Schema
-
-**返回**: **Object** - 内部If结构
-
-**示例**:
-```javascript
-dsl.if('isVip', 'number:0-50', 'number:0-10')
-```
-
----
-
-## DslBuilder 类
-
-### 描述
-
-Schema 构建器类，支持链式调用添加验证规则。
-
-### 构造函数
-
-```javascript
-new DslBuilder(dslString: string)
-```
+## Validator 类
 
 **参数**:
 - `dslString` (**string**) - DSL字符串，如 `'string:3-32!'`