schema-dsl 1.1.3 → 1.1.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +75 -1275
- package/README.md +221 -2
- package/STATUS.md +34 -2
- package/changelogs/v1.0.0.md +328 -0
- package/changelogs/v1.0.9.md +367 -0
- package/changelogs/v1.1.0.md +389 -0
- package/changelogs/v1.1.1.md +308 -0
- package/changelogs/v1.1.2.md +183 -0
- package/changelogs/v1.1.3.md +161 -0
- package/changelogs/v1.1.4.md +432 -0
- package/docs/dsl-syntax.md +14 -3
- package/docs/optional-marker-guide.md +321 -0
- package/docs/runtime-locale-support.md +443 -0
- package/index.d.ts +126 -10
- package/index.js +6 -3
- package/index.mjs +2 -2
- package/lib/core/DslBuilder.js +11 -2
- package/lib/errors/I18nError.js +21 -6
- package/package.json +1 -1
|
@@ -0,0 +1,183 @@
|
|
|
1
|
+
# v1.1.2 变更日志
|
|
2
|
+
|
|
3
|
+
> **发布日期**: 2026-01-06
|
|
4
|
+
> **版本号**: v1.1.2
|
|
5
|
+
> **类型**: 🎉 新功能
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## 📋 变更概览
|
|
10
|
+
|
|
11
|
+
| 类型 | 数量 | 说明 |
|
|
12
|
+
|------|------|------|
|
|
13
|
+
| 🎉 新功能 | 1 | 数字比较运算符 |
|
|
14
|
+
| 🐛 Bug修复 | 若干 | 小问题修复 |
|
|
15
|
+
|
|
16
|
+
---
|
|
17
|
+
|
|
18
|
+
## 🎉 新功能
|
|
19
|
+
|
|
20
|
+
### 数字比较运算符 - 更直观的数值验证
|
|
21
|
+
|
|
22
|
+
**新增 5 种比较运算符,让数值验证更语义化**
|
|
23
|
+
|
|
24
|
+
现在 `number` 和 `integer` 类型支持 5 种比较运算符:`>`, `>=`, `<`, `<=`, `=`
|
|
25
|
+
|
|
26
|
+
#### 基础用法
|
|
27
|
+
|
|
28
|
+
```javascript
|
|
29
|
+
const { dsl, validate } = require('schema-dsl');
|
|
30
|
+
|
|
31
|
+
// ✅ 大于(不包括边界)
|
|
32
|
+
const schema1 = dsl({ value: 'number:>0' });
|
|
33
|
+
validate(schema1, { value: 1 }); // ✅ true
|
|
34
|
+
validate(schema1, { value: 0 }); // ❌ false (0不满足>0)
|
|
35
|
+
|
|
36
|
+
// ✅ 大于等于
|
|
37
|
+
const schema2 = dsl({ age: 'number:>=18' });
|
|
38
|
+
validate(schema2, { age: 18 }); // ✅ true (包括18)
|
|
39
|
+
validate(schema2, { age: 17 }); // ❌ false
|
|
40
|
+
|
|
41
|
+
// ✅ 小于(不包括边界)
|
|
42
|
+
const schema3 = dsl({ temp: 'number:<100' });
|
|
43
|
+
validate(schema3, { temp: 99.9 }); // ✅ true
|
|
44
|
+
validate(schema3, { temp: 100 }); // ❌ false (100不满足<100)
|
|
45
|
+
|
|
46
|
+
// ✅ 小于等于
|
|
47
|
+
const schema4 = dsl({ score: 'number:<=100' });
|
|
48
|
+
validate(schema4, { score: 100 }); // ✅ true (包括100)
|
|
49
|
+
|
|
50
|
+
// ✅ 等于
|
|
51
|
+
const schema5 = dsl({ level: 'number:=5' });
|
|
52
|
+
validate(schema5, { level: 5 }); // ✅ true
|
|
53
|
+
validate(schema5, { level: 4 }); // ❌ false
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
#### 支持小数和负数
|
|
57
|
+
|
|
58
|
+
```javascript
|
|
59
|
+
// 小数
|
|
60
|
+
dsl({ value: 'number:>0.5' }) // 大于0.5
|
|
61
|
+
dsl({ price: 'number:<=99.99' }) // 小于等于99.99
|
|
62
|
+
|
|
63
|
+
// 负数
|
|
64
|
+
dsl({ value: 'number:>-10' }) // 大于-10
|
|
65
|
+
dsl({ temp: 'number:<-5' }) // 小于-5
|
|
66
|
+
|
|
67
|
+
// 配合必填标记
|
|
68
|
+
dsl({ age: 'number:>=18!' }) // 必填且大于等于18
|
|
69
|
+
dsl({ price: 'number:>0!' }) // 必填且大于0
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
#### 对比:比较运算符 vs 范围语法
|
|
73
|
+
|
|
74
|
+
| 需求 | 范围语法 | 比较运算符 | 推荐 |
|
|
75
|
+
|------|---------|-----------|------|
|
|
76
|
+
| x ≥ 18 | `number:18-` | `number:>=18` | **比较运算符**(更清晰) |
|
|
77
|
+
| x > 0(不包括0) | ❌ 无法表达 | `number:>0` | **比较运算符**(唯一方法) |
|
|
78
|
+
| x < 100(不包括100) | ❌ 无法表达 | `number:<100` | **比较运算符**(唯一方法) |
|
|
79
|
+
| x = 100 | `number:100`(实际≤100) | `number:=100` | **比较运算符**(精确匹配) |
|
|
80
|
+
| 18 ≤ x ≤ 100 | `number:18-100` | - | **范围语法**(更简洁) |
|
|
81
|
+
|
|
82
|
+
#### 实际应用场景
|
|
83
|
+
|
|
84
|
+
**场景1:用户注册 - 年龄限制**
|
|
85
|
+
```javascript
|
|
86
|
+
const schema = dsl({
|
|
87
|
+
username: 'string:3-32!',
|
|
88
|
+
email: 'email!',
|
|
89
|
+
age: 'number:>=18!', // 必须年满18岁
|
|
90
|
+
password: 'string:8-!'
|
|
91
|
+
});
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
**场景2:电商系统 - 价格验证**
|
|
95
|
+
```javascript
|
|
96
|
+
const schema = dsl({
|
|
97
|
+
productName: 'string:1-100!',
|
|
98
|
+
price: 'number:>0!', // 价格必须大于0
|
|
99
|
+
discount: 'number:0-100' // 折扣 0-100
|
|
100
|
+
});
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
**场景3:温度监控 - 范围告警**
|
|
104
|
+
```javascript
|
|
105
|
+
const schema = dsl({
|
|
106
|
+
temperature: 'number:<100', // 温度不能达到100度
|
|
107
|
+
humidity: 'number:>=30' // 湿度至少30%
|
|
108
|
+
});
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
**场景4:评分系统 - 精确值**
|
|
112
|
+
```javascript
|
|
113
|
+
const schema = dsl({
|
|
114
|
+
rating: 'number:=5', // 五星好评
|
|
115
|
+
stars: 'integer:1-5' // 1-5星
|
|
116
|
+
});
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
---
|
|
120
|
+
|
|
121
|
+
## 🐛 Bug 修复
|
|
122
|
+
|
|
123
|
+
- ✅ 修复边界值判断的边缘情况
|
|
124
|
+
- ✅ 修复错误消息模板中的参数传递
|
|
125
|
+
- ✅ 优化数字类型的性能
|
|
126
|
+
|
|
127
|
+
---
|
|
128
|
+
|
|
129
|
+
## 📚 文档更新
|
|
130
|
+
|
|
131
|
+
- ✅ 新增数字比较运算符文档
|
|
132
|
+
- ✅ 更新类型参考文档
|
|
133
|
+
- ✅ 添加实际场景示例
|
|
134
|
+
|
|
135
|
+
---
|
|
136
|
+
|
|
137
|
+
## 🔄 破坏性变更
|
|
138
|
+
|
|
139
|
+
**无破坏性变更** - 所有新功能都是向后兼容的。
|
|
140
|
+
|
|
141
|
+
---
|
|
142
|
+
|
|
143
|
+
## 🎯 升级指南
|
|
144
|
+
|
|
145
|
+
### 从 v1.1.1 升级到 v1.1.2
|
|
146
|
+
|
|
147
|
+
```bash
|
|
148
|
+
npm install schema-dsl@1.1.2
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
**可选:使用新的比较运算符**
|
|
152
|
+
|
|
153
|
+
```javascript
|
|
154
|
+
// 之前:使用范围语法
|
|
155
|
+
const schema1 = dsl({ age: 'number:18-' }); // >=18
|
|
156
|
+
|
|
157
|
+
// 现在:使用比较运算符(更清晰)
|
|
158
|
+
const schema2 = dsl({ age: 'number:>=18' }); // >=18
|
|
159
|
+
|
|
160
|
+
// 新功能:排除边界值
|
|
161
|
+
const schema3 = dsl({ value: 'number:>0' }); // >0(不包括0)
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
---
|
|
165
|
+
|
|
166
|
+
## 📦 依赖变更
|
|
167
|
+
|
|
168
|
+
**无依赖变更**
|
|
169
|
+
|
|
170
|
+
---
|
|
171
|
+
|
|
172
|
+
## 🔗 相关链接
|
|
173
|
+
|
|
174
|
+
- [GitHub Repository](https://github.com/vextjs/schema-dsl)
|
|
175
|
+
- [npm Package](https://www.npmjs.com/package/schema-dsl)
|
|
176
|
+
- [数字运算符文档](../docs/number-operators.md)
|
|
177
|
+
|
|
178
|
+
---
|
|
179
|
+
|
|
180
|
+
**发布者**: schema-dsl Team
|
|
181
|
+
**发布时间**: 2026-01-06
|
|
182
|
+
**下一版本**: v1.1.3
|
|
183
|
+
|
|
@@ -0,0 +1,161 @@
|
|
|
1
|
+
# v1.1.3 变更日志
|
|
2
|
+
|
|
3
|
+
> **发布日期**: 2026-01-09
|
|
4
|
+
> **版本号**: v1.1.3
|
|
5
|
+
> **类型**: 🐛 Bug修复
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## 📋 变更概览
|
|
10
|
+
|
|
11
|
+
| 类型 | 数量 | 说明 |
|
|
12
|
+
|------|------|------|
|
|
13
|
+
| 🐛 Bug修复 | 1 | 类型错误消息模板变量未替换 |
|
|
14
|
+
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
## 🐛 Bug 修复
|
|
18
|
+
|
|
19
|
+
### 类型验证错误消息模板变量未替换
|
|
20
|
+
|
|
21
|
+
**问题描述**:
|
|
22
|
+
当类型验证失败时,错误消息中的 `{{#actual}}` 模板变量没有被替换,导致错误消息显示不完整。
|
|
23
|
+
|
|
24
|
+
**修复前**:
|
|
25
|
+
```javascript
|
|
26
|
+
const schema = dsl({ age: 'string!' });
|
|
27
|
+
const result = validate(schema, { age: 25 });
|
|
28
|
+
// ❌ 错误消息: "age should be string, got {{#actual}}"
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
**修复后**:
|
|
32
|
+
```javascript
|
|
33
|
+
const schema = dsl({ age: 'string!' });
|
|
34
|
+
const result = validate(schema, { age: 25 });
|
|
35
|
+
// ✅ 错误消息: "age should be string, got number"
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
**技术细节**:
|
|
39
|
+
|
|
40
|
+
修复文件:`lib/core/ErrorFormatter.js` 第 280-284 行
|
|
41
|
+
|
|
42
|
+
**修复前代码**:
|
|
43
|
+
```javascript
|
|
44
|
+
static formatDetailed(error, data, customMessages = {}, locale = 'en-US') {
|
|
45
|
+
// ... existing code ...
|
|
46
|
+
|
|
47
|
+
// ❌ 缺少 actual 参数
|
|
48
|
+
const message = MessageTemplate.render(template, {
|
|
49
|
+
value: data,
|
|
50
|
+
min: error.params?.limit,
|
|
51
|
+
max: error.params?.limit,
|
|
52
|
+
// 缺少 actual 参数
|
|
53
|
+
});
|
|
54
|
+
}
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
**修复后代码**:
|
|
58
|
+
```javascript
|
|
59
|
+
static formatDetailed(error, data, customMessages = {}, locale = 'en-US') {
|
|
60
|
+
// ... existing code ...
|
|
61
|
+
|
|
62
|
+
// ✅ 添加 actual 参数计算逻辑
|
|
63
|
+
const actual = data === null ? 'null'
|
|
64
|
+
: data === undefined ? 'undefined'
|
|
65
|
+
: Array.isArray(data) ? 'array'
|
|
66
|
+
: typeof data;
|
|
67
|
+
|
|
68
|
+
const message = MessageTemplate.render(template, {
|
|
69
|
+
value: data,
|
|
70
|
+
min: error.params?.limit,
|
|
71
|
+
max: error.params?.limit,
|
|
72
|
+
actual: actual // ✅ 添加 actual 参数
|
|
73
|
+
});
|
|
74
|
+
}
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
**支持的数据类型**:
|
|
78
|
+
- ✅ `number` - 数字类型
|
|
79
|
+
- ✅ `string` - 字符串类型
|
|
80
|
+
- ✅ `boolean` - 布尔类型
|
|
81
|
+
- ✅ `object` - 对象类型
|
|
82
|
+
- ✅ `array` - 数组类型
|
|
83
|
+
- ✅ `null` - 空值
|
|
84
|
+
- ✅ `undefined` - 未定义
|
|
85
|
+
|
|
86
|
+
---
|
|
87
|
+
|
|
88
|
+
## 📊 影响范围
|
|
89
|
+
|
|
90
|
+
### 影响的功能
|
|
91
|
+
|
|
92
|
+
- ✅ **类型验证错误消息**: 正确显示实际数据类型
|
|
93
|
+
- ✅ **多语言错误消息**: `{{#actual}}` 变量在所有语言中正确替换
|
|
94
|
+
- ✅ **开发体验**: 错误消息更清晰,便于调试
|
|
95
|
+
|
|
96
|
+
### 不影响的功能
|
|
97
|
+
|
|
98
|
+
- ✅ **验证逻辑**: 验证功能本身不受影响
|
|
99
|
+
- ✅ **其他错误消息**: 非类型验证的错误消息不受影响
|
|
100
|
+
- ✅ **API接口**: 所有API保持不变
|
|
101
|
+
|
|
102
|
+
---
|
|
103
|
+
|
|
104
|
+
## ✅ 向后兼容性
|
|
105
|
+
|
|
106
|
+
- ✅ **无破坏性变更**: 完全向后兼容
|
|
107
|
+
- ✅ **API不变**: 所有公开API保持不变
|
|
108
|
+
- ✅ **配置不变**: 无需修改配置
|
|
109
|
+
|
|
110
|
+
---
|
|
111
|
+
|
|
112
|
+
## 🎯 升级指南
|
|
113
|
+
|
|
114
|
+
### 从 v1.1.2 升级到 v1.1.3
|
|
115
|
+
|
|
116
|
+
**推荐操作**:
|
|
117
|
+
```bash
|
|
118
|
+
npm install schema-dsl@1.1.3
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
**无需修改代码**: 本次更新仅修复错误消息显示,不影响验证逻辑。
|
|
122
|
+
|
|
123
|
+
**验证升级成功**:
|
|
124
|
+
```javascript
|
|
125
|
+
const { dsl, validate } = require('schema-dsl');
|
|
126
|
+
|
|
127
|
+
// 测试类型验证错误消息
|
|
128
|
+
const schema = dsl({ age: 'string!' });
|
|
129
|
+
const result = validate(schema, { age: 25 });
|
|
130
|
+
|
|
131
|
+
console.log(result.errors[0].message);
|
|
132
|
+
// 应该输出: "age should be string, got number"
|
|
133
|
+
// 而不是: "age should be string, got {{#actual}}"
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
---
|
|
137
|
+
|
|
138
|
+
## 📦 依赖变更
|
|
139
|
+
|
|
140
|
+
**无依赖变更**
|
|
141
|
+
|
|
142
|
+
---
|
|
143
|
+
|
|
144
|
+
## 🙏 致谢
|
|
145
|
+
|
|
146
|
+
感谢 [monSQLize](https://github.com/zy410419243/monSQLize) 项目发现并报告此问题。
|
|
147
|
+
|
|
148
|
+
---
|
|
149
|
+
|
|
150
|
+
## 🔗 相关链接
|
|
151
|
+
|
|
152
|
+
- [GitHub Repository](https://github.com/vextjs/schema-dsl)
|
|
153
|
+
- [npm Package](https://www.npmjs.com/package/schema-dsl)
|
|
154
|
+
- [Issue #XXX](https://github.com/vextjs/schema-dsl/issues/XXX) - 相关Issue
|
|
155
|
+
|
|
156
|
+
---
|
|
157
|
+
|
|
158
|
+
**发布者**: schema-dsl Team
|
|
159
|
+
**发布时间**: 2026-01-09
|
|
160
|
+
**下一版本**: v1.1.4
|
|
161
|
+
|