schema-dsl 1.2.5 → 2.0.1

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.
Files changed (243) hide show
  1. package/CHANGELOG.md +130 -238
  2. package/LICENSE +21 -21
  3. package/README.md +628 -2486
  4. package/dist/DslBuilder-BIgQOAXp.d.ts +343 -0
  5. package/dist/DslBuilder-CjHTucNQ.d.cts +343 -0
  6. package/dist/Validator-CllRdrY0.d.ts +192 -0
  7. package/dist/Validator-D6okG9tr.d.cts +192 -0
  8. package/dist/index.cjs +6640 -0
  9. package/dist/index.d.cts +1151 -0
  10. package/dist/index.d.ts +1151 -0
  11. package/dist/index.js +6574 -0
  12. package/dist/plugin-CIKtTMtS.d.cts +246 -0
  13. package/dist/plugin-CIKtTMtS.d.ts +246 -0
  14. package/dist/plugins/custom-format.cjs +3818 -0
  15. package/dist/plugins/custom-format.d.cts +12 -0
  16. package/dist/plugins/custom-format.d.ts +12 -0
  17. package/dist/plugins/custom-format.js +3788 -0
  18. package/dist/plugins/custom-type-example.cjs +3811 -0
  19. package/dist/plugins/custom-type-example.d.cts +8 -0
  20. package/dist/plugins/custom-type-example.d.ts +8 -0
  21. package/dist/plugins/custom-type-example.js +3781 -0
  22. package/dist/plugins/custom-validator.cjs +144 -0
  23. package/dist/plugins/custom-validator.d.cts +10 -0
  24. package/dist/plugins/custom-validator.d.ts +10 -0
  25. package/dist/plugins/custom-validator.js +119 -0
  26. package/docs/FEATURE-INDEX.md +553 -519
  27. package/docs/add-custom-locale.md +496 -483
  28. package/docs/add-keyword.md +24 -0
  29. package/docs/api-reference.md +1047 -805
  30. package/docs/api.md +13 -0
  31. package/docs/best-practices-project-structure.md +417 -408
  32. package/docs/best-practices.md +712 -672
  33. package/docs/cache-manager.md +344 -336
  34. package/docs/compile.md +45 -0
  35. package/docs/conditional-api.md +1307 -1278
  36. package/docs/custom-extensions-guide.md +339 -411
  37. package/docs/design-philosophy.md +606 -601
  38. package/docs/doc-index.md +324 -0
  39. package/docs/dsl-syntax.md +714 -664
  40. package/docs/dynamic-locale.md +608 -598
  41. package/docs/enum.md +482 -475
  42. package/docs/error-handling.md +1975 -1966
  43. package/docs/export-guide.md +501 -462
  44. package/docs/export-limitations.md +567 -551
  45. package/docs/faq.md +596 -577
  46. package/docs/frontend-i18n-guide.md +307 -293
  47. package/docs/i18n-user-guide.md +487 -474
  48. package/docs/i18n.md +476 -457
  49. package/docs/index.md +48 -0
  50. package/docs/json-schema-basics.md +40 -0
  51. package/docs/label-vs-description.md +271 -262
  52. package/docs/markdown-exporter.md +406 -397
  53. package/docs/mongodb-exporter.md +302 -295
  54. package/docs/multi-language.md +26 -0
  55. package/docs/multi-type-support.md +322 -329
  56. package/docs/mysql-exporter.md +280 -273
  57. package/docs/number-operators.md +449 -442
  58. package/docs/optional-marker-guide.md +326 -321
  59. package/docs/performance-guide.md +49 -0
  60. package/docs/plugin-system.md +381 -542
  61. package/docs/plugin-type-registration.md +34 -0
  62. package/docs/postgresql-exporter.md +311 -304
  63. package/docs/public/favicon.svg +5 -0
  64. package/docs/quick-start.md +435 -761
  65. package/docs/runtime-locale-support.md +532 -521
  66. package/docs/schema-helper.md +345 -340
  67. package/docs/schema-utils-advanced-issues.md +23 -0
  68. package/docs/schema-utils-best-practices.md +20 -0
  69. package/docs/schema-utils-chaining.md +150 -143
  70. package/docs/schema-utils.md +524 -490
  71. package/docs/security-checklist.md +20 -0
  72. package/docs/string-extensions.md +488 -480
  73. package/docs/troubleshooting.md +486 -471
  74. package/docs/type-converter.md +310 -319
  75. package/docs/type-reference.md +242 -219
  76. package/docs/typescript-guide.md +584 -573
  77. package/docs/union-type-guide.md +157 -147
  78. package/docs/union-types.md +284 -277
  79. package/docs/validate-async.md +491 -480
  80. package/docs/validate-batch.md +49 -0
  81. package/docs/validate-dsl-object-support.md +578 -573
  82. package/docs/validate.md +506 -486
  83. package/docs/validation-guide.md +502 -484
  84. package/docs/validator.md +39 -0
  85. package/package.json +131 -73
  86. package/plugins/custom-format.cjs +8 -0
  87. package/plugins/custom-type-example.cjs +8 -0
  88. package/plugins/custom-validator.cjs +8 -0
  89. package/src/adapters/DslAdapter.ts +111 -0
  90. package/src/adapters/index.ts +1 -0
  91. package/src/config/constants.ts +83 -0
  92. package/src/config/index.ts +2 -0
  93. package/src/config/patterns.ts +77 -0
  94. package/src/core/CacheManager.ts +169 -0
  95. package/src/core/ConditionalBuilder.ts +382 -0
  96. package/src/core/ConditionalRuntime.ts +28 -0
  97. package/src/core/ConditionalValidator.ts +255 -0
  98. package/src/core/DslBuilder.ts +687 -0
  99. package/src/core/ErrorCodes.ts +38 -0
  100. package/src/core/ErrorFormatter.ts +271 -0
  101. package/src/core/JSONSchemaCore.ts +65 -0
  102. package/src/core/Locale.ts +187 -0
  103. package/src/core/MessageTemplate.ts +42 -0
  104. package/src/core/ObjectDslBuilder.ts +64 -0
  105. package/src/core/PluginManager.ts +326 -0
  106. package/src/core/StringExtensions.ts +140 -0
  107. package/src/core/TemplateEngine.ts +44 -0
  108. package/src/core/Validator.ts +448 -0
  109. package/src/errors/I18nError.ts +159 -0
  110. package/src/errors/ValidationError.ts +105 -0
  111. package/src/exporters/BaseExporter.ts +60 -0
  112. package/src/exporters/MarkdownExporter.ts +305 -0
  113. package/src/exporters/MongoDBExporter.ts +126 -0
  114. package/src/exporters/MySQLExporter.ts +156 -0
  115. package/src/exporters/PostgreSQLExporter.ts +222 -0
  116. package/src/exporters/index.ts +18 -0
  117. package/src/index.ts +651 -0
  118. package/{lib/locales/en-US.js → src/locales/en-US.ts} +160 -176
  119. package/{lib/locales/es-ES.js → src/locales/es-ES.ts} +160 -113
  120. package/{lib/locales/fr-FR.js → src/locales/fr-FR.ts} +160 -113
  121. package/src/locales/index.ts +103 -0
  122. package/{lib/locales/ja-JP.js → src/locales/ja-JP.ts} +160 -118
  123. package/src/locales/types.ts +156 -0
  124. package/{lib/locales/zh-CN.js → src/locales/zh-CN.ts} +160 -177
  125. package/src/parser/ConstraintParser.ts +101 -0
  126. package/src/parser/DslParser.ts +470 -0
  127. package/src/parser/SchemaCompiler.ts +66 -0
  128. package/src/parser/TypeRegistry.ts +250 -0
  129. package/src/parser/index.ts +6 -0
  130. package/src/plugins/custom-format.ts +124 -0
  131. package/src/plugins/custom-type-example.ts +106 -0
  132. package/src/plugins/custom-validator.ts +138 -0
  133. package/src/types/conditional.ts +28 -0
  134. package/src/types/config.ts +59 -0
  135. package/src/types/dsl.ts +131 -0
  136. package/src/types/error.ts +60 -0
  137. package/src/types/index.ts +17 -0
  138. package/src/types/infer.ts +128 -0
  139. package/src/types/plugin.ts +58 -0
  140. package/src/types/safe-regex.d.ts +9 -0
  141. package/src/types/schema.ts +66 -0
  142. package/src/types/validate.ts +71 -0
  143. package/src/utils/SchemaHelper.ts +196 -0
  144. package/src/utils/SchemaUtils.ts +365 -0
  145. package/src/utils/TypeConverter.ts +215 -0
  146. package/src/utils/index.ts +10 -0
  147. package/src/validators/CustomKeywords.ts +477 -0
  148. package/.eslintignore +0 -11
  149. package/.eslintrc.json +0 -27
  150. package/CONTRIBUTING.md +0 -368
  151. package/STATUS.md +0 -491
  152. package/changelogs/v1.0.0.md +0 -328
  153. package/changelogs/v1.0.9.md +0 -367
  154. package/changelogs/v1.1.0.md +0 -389
  155. package/changelogs/v1.1.1.md +0 -308
  156. package/changelogs/v1.1.2.md +0 -183
  157. package/changelogs/v1.1.3.md +0 -161
  158. package/changelogs/v1.1.4.md +0 -432
  159. package/changelogs/v1.1.5.md +0 -493
  160. package/changelogs/v1.1.6.md +0 -211
  161. package/changelogs/v1.1.8.md +0 -376
  162. package/changelogs/v1.2.3.md +0 -124
  163. package/docs/INDEX.md +0 -252
  164. package/docs/issues-resolved-summary.md +0 -196
  165. package/docs/performance-benchmark-report.md +0 -179
  166. package/docs/performance-quick-reference.md +0 -123
  167. package/docs/user-questions-answered.md +0 -353
  168. package/docs/validation-rules-v1.0.2.md +0 -1608
  169. package/examples/README.md +0 -81
  170. package/examples/array-dsl-example.js +0 -227
  171. package/examples/conditional-example.js +0 -288
  172. package/examples/conditional-non-object.js +0 -129
  173. package/examples/conditional-validate-example.js +0 -321
  174. package/examples/custom-extension.js +0 -85
  175. package/examples/dsl-match-example.js +0 -74
  176. package/examples/dsl-style.js +0 -118
  177. package/examples/dynamic-locale-configuration.js +0 -348
  178. package/examples/dynamic-locale-example.js +0 -287
  179. package/examples/enum.examples.js +0 -324
  180. package/examples/export-demo.js +0 -130
  181. package/examples/express-integration.js +0 -376
  182. package/examples/i18n-error-handling-complete.js +0 -381
  183. package/examples/i18n-error-handling-quickstart.md +0 -0
  184. package/examples/i18n-error.examples.js +0 -181
  185. package/examples/i18n-full-demo.js +0 -301
  186. package/examples/i18n-memory-safety.examples.js +0 -268
  187. package/examples/markdown-export.js +0 -71
  188. package/examples/middleware-usage.js +0 -93
  189. package/examples/new-features-comparison.js +0 -315
  190. package/examples/password-reset/README.md +0 -153
  191. package/examples/password-reset/schema.js +0 -26
  192. package/examples/password-reset/test.js +0 -101
  193. package/examples/plugin-system.examples.js +0 -205
  194. package/examples/schema-utils-chaining.examples.js +0 -250
  195. package/examples/simple-example.js +0 -122
  196. package/examples/slug.examples.js +0 -179
  197. package/examples/string-extensions.js +0 -297
  198. package/examples/union-type-example.js +0 -127
  199. package/examples/union-types-example.js +0 -77
  200. package/examples/user-registration/README.md +0 -156
  201. package/examples/user-registration/routes.js +0 -92
  202. package/examples/user-registration/schema.js +0 -150
  203. package/examples/user-registration/server.js +0 -74
  204. package/index.d.ts +0 -3658
  205. package/index.js +0 -475
  206. package/index.mjs +0 -60
  207. package/lib/adapters/DslAdapter.js +0 -995
  208. package/lib/adapters/index.js +0 -20
  209. package/lib/config/constants.js +0 -286
  210. package/lib/config/patterns/common.js +0 -47
  211. package/lib/config/patterns/creditCard.js +0 -9
  212. package/lib/config/patterns/idCard.js +0 -9
  213. package/lib/config/patterns/index.js +0 -9
  214. package/lib/config/patterns/licensePlate.js +0 -4
  215. package/lib/config/patterns/passport.js +0 -4
  216. package/lib/config/patterns/phone.js +0 -9
  217. package/lib/config/patterns/postalCode.js +0 -5
  218. package/lib/core/CacheManager.js +0 -376
  219. package/lib/core/ConditionalBuilder.js +0 -503
  220. package/lib/core/DslBuilder.js +0 -1589
  221. package/lib/core/ErrorCodes.js +0 -233
  222. package/lib/core/ErrorFormatter.js +0 -445
  223. package/lib/core/JSONSchemaCore.js +0 -347
  224. package/lib/core/Locale.js +0 -130
  225. package/lib/core/MessageTemplate.js +0 -98
  226. package/lib/core/PluginManager.js +0 -448
  227. package/lib/core/StringExtensions.js +0 -240
  228. package/lib/core/Validator.js +0 -654
  229. package/lib/errors/I18nError.js +0 -328
  230. package/lib/errors/ValidationError.js +0 -191
  231. package/lib/exporters/MarkdownExporter.js +0 -420
  232. package/lib/exporters/MongoDBExporter.js +0 -162
  233. package/lib/exporters/MySQLExporter.js +0 -212
  234. package/lib/exporters/PostgreSQLExporter.js +0 -289
  235. package/lib/exporters/index.js +0 -24
  236. package/lib/locales/index.js +0 -8
  237. package/lib/utils/LRUCache.js +0 -174
  238. package/lib/utils/SchemaHelper.js +0 -240
  239. package/lib/utils/SchemaUtils.js +0 -445
  240. package/lib/utils/TypeConverter.js +0 -245
  241. package/lib/utils/index.js +0 -13
  242. package/lib/validators/CustomKeywords.js +0 -616
  243. package/lib/validators/index.js +0 -11
@@ -1,480 +1,491 @@
1
- # validateAsync - 异步验证
2
-
3
- > 验证失败自动抛出错误
4
-
5
- ---
6
-
7
- ## 快速开始
8
-
9
- ```javascript
10
- const { dsl, validateAsync } = require('schema-dsl');
11
-
12
- const userSchema = dsl({
13
- name: 'string!',
14
- email: 'email!',
15
- age: 'integer:18-120'
16
- });
17
-
18
- try {
19
- const data = await validateAsync(userSchema, {
20
- name: 'John',
21
- email: 'john@example.com',
22
- age: 30
23
- });
24
-
25
- console.log('验证成功:', data);
26
- } catch (error) {
27
- console.error('验证失败:', error.message);
28
- }
29
- ```
30
-
31
- ---
32
-
33
- ## 基础用法
34
- name: '',
35
- email: 'invalid'
36
- });
37
- } catch (error) {
38
- console.log(error instanceof ValidationError); // true
39
- console.log(error.getFieldErrors());
40
- // { name: '长度必须大于等于1', email: '邮箱格式错误', age: '字段必填' }
41
- }
42
- ```
43
-
44
- ---
45
-
46
- ## ValidationError
47
-
48
- ### 属性
49
-
50
- ```javascript
51
- class ValidationError extends Error {
52
- name: 'ValidationError' // 错误名称
53
- message: string // 友好的错误消息
54
- errors: Array<Object> // 原始错误列表
55
- data: any // 原始输入数据
56
- statusCode: 400 // HTTP 状态码
57
- }
58
- ```
59
-
60
- ### 方法
61
-
62
- #### 1. `toJSON()` - 转换为 JSON(用于 API 响应)
63
-
64
- ```javascript
65
- try {
66
- await validateAsync(schema, data);
67
- } catch (error) {
68
- const json = error.toJSON();
69
- // {
70
- // error: 'ValidationError',
71
- // message: 'Validation failed: name: 字段必填',
72
- // statusCode: 400,
73
- // details: [
74
- // { field: 'name', message: '字段必填', keyword: 'required', params: {...} }
75
- // ]
76
- // }
77
- }
78
- ```
79
-
80
- #### 2. `getFieldError(field)` - 获取指定字段的错误
81
-
82
- ```javascript
83
- try {
84
- await validateAsync(schema, data);
85
- } catch (error) {
86
- const nameError = error.getFieldError('name');
87
- console.log(nameError.message); // '字段必填'
88
- }
89
- ```
90
-
91
- #### 3. `getFieldErrors()` - 获取所有字段的错误映射
92
-
93
- ```javascript
94
- try {
95
- await validateAsync(schema, data);
96
- } catch (error) {
97
- const fieldErrors = error.getFieldErrors();
98
- // { name: '字段必填', email: '邮箱格式错误' }
99
- }
100
- ```
101
-
102
- #### 4. `hasFieldError(field)` - 检查字段是否有错误
103
-
104
- ```javascript
105
- try {
106
- await validateAsync(schema, data);
107
- } catch (error) {
108
- if (error.hasFieldError('email')) {
109
- console.log('邮箱格式错误');
110
- }
111
- }
112
- ```
113
-
114
- #### 5. `getErrorCount()` - 获取错误数量
115
-
116
- ```javascript
117
- try {
118
- await validateAsync(schema, data);
119
- } catch (error) {
120
- console.log(`发现 ${error.getErrorCount()} 个错误`);
121
- }
122
- ```
123
-
124
- ---
125
-
126
- ## Express 集成
127
-
128
- ### 基础集成
129
-
130
- ```javascript
131
- const express = require('express');
132
- const { dsl, validateAsync, ValidationError } = require('schema-dsl');
133
-
134
- const app = express();
135
- app.use(express.json());
136
-
137
- // 定义 Schema
138
- const userSchema = dsl({
139
- name: 'string:1-50!',
140
- email: 'email!',
141
- age: 'integer:18-120'
142
- });
143
-
144
- // 路由处理
145
- app.post('/users', async (req, res, next) => {
146
- try {
147
- // 验证请求体
148
- const validData = await validateAsync(userSchema, req.body);
149
-
150
- // 保存到数据库
151
- const user = await db.users.insert(validData);
152
-
153
- res.status(201).json({ success: true, user });
154
- } catch (error) {
155
- next(error); // 传递给错误处理中间件
156
- }
157
- });
158
-
159
- // 全局错误处理中间件
160
- app.use((error, req, res, next) => {
161
- if (error instanceof ValidationError) {
162
- return res.status(error.statusCode).json(error.toJSON());
163
- }
164
-
165
- // 其他错误
166
- res.status(500).json({ error: 'Internal Server Error' });
167
- });
168
-
169
- app.listen(3000);
170
- ```
171
-
172
- ### 完整 CRUD 示例
173
-
174
- ```javascript
175
- const { SchemaUtils } = require('schema-dsl');
176
-
177
- // 定义完整 Schema
178
- const fullUserSchema = dsl({
179
- id: 'objectId!',
180
- name: 'string:1-50!',
181
- email: 'email!',
182
- password: 'string:8-32!',
183
- age: 'integer:18-120',
184
- createdAt: 'date',
185
- updatedAt: 'date'
186
- });
187
-
188
- // POST /users - 创建用户(严格模式)
189
- const createSchema = SchemaUtils
190
- .omit(fullUserSchema, ['id', 'createdAt', 'updatedAt'])
191
- .strict();
192
-
193
- app.post('/users', async (req, res, next) => {
194
- try {
195
- const data = await validateAsync(createSchema, req.body);
196
- const user = await db.users.insert({
197
- ...data,
198
- createdAt: new Date(),
199
- updatedAt: new Date()
200
- });
201
- res.status(201).json(user);
202
- } catch (error) {
203
- next(error);
204
- }
205
- });
206
-
207
- // GET /users/:id - 查询用户(移除敏感字段)
208
- const publicSchema = SchemaUtils
209
- .omit(fullUserSchema, ['password'])
210
- .clean();
211
-
212
- app.get('/users/:id', async (req, res, next) => {
213
- try {
214
- const user = await db.users.findById(req.params.id);
215
- const { validate } = require('schema-dsl');
216
- const result = validate(publicSchema, user);
217
- res.json(result.data); // 自动移除 password
218
- } catch (error) {
219
- next(error);
220
- }
221
- });
222
-
223
- // PATCH /users/:id - 更新用户(部分验证)
224
- const updateSchema = SchemaUtils
225
- .pick(fullUserSchema, ['name', 'age'])
226
- .partial()
227
- .loose();
228
-
229
- app.patch('/users/:id', async (req, res, next) => {
230
- try {
231
- const data = await validateAsync(updateSchema, req.body);
232
- const user = await db.users.updateById(req.params.id, {
233
- ...data,
234
- updatedAt: new Date()
235
- });
236
- res.json(user);
237
- } catch (error) {
238
- next(error);
239
- }
240
- });
241
-
242
- // PUT /users/:id - 替换用户(严格模式)
243
- const replaceSchema = SchemaUtils
244
- .omit(fullUserSchema, ['id', 'createdAt', 'updatedAt'])
245
- .strict();
246
-
247
- app.put('/users/:id', async (req, res, next) => {
248
- try {
249
- const data = await validateAsync(replaceSchema, req.body);
250
- const user = await db.users.replaceById(req.params.id, {
251
- ...data,
252
- updatedAt: new Date()
253
- });
254
- res.json(user);
255
- } catch (error) {
256
- next(error);
257
- }
258
- });
259
- ```
260
-
261
- ---
262
-
263
- ## 错误处理
264
-
265
- ### 自定义错误格式
266
-
267
- ```javascript
268
- app.use((error, req, res, next) => {
269
- if (error instanceof ValidationError) {
270
- // 自定义错误响应格式
271
- return res.status(422).json({
272
- code: 'VALIDATION_FAILED',
273
- message: '数据验证失败',
274
- timestamp: new Date().toISOString(),
275
- fields: error.getFieldErrors()
276
- });
277
- }
278
-
279
- next(error);
280
- });
281
- ```
282
-
283
- ### 分类错误处理
284
-
285
- ```javascript
286
- app.use((error, req, res, next) => {
287
- if (error instanceof ValidationError) {
288
- const fieldErrors = error.getFieldErrors();
289
-
290
- // 邮箱格式错误
291
- if (error.hasFieldError('email')) {
292
- return res.status(400).json({
293
- code: 'INVALID_EMAIL',
294
- message: '邮箱格式错误',
295
- field: 'email'
296
- });
297
- }
298
-
299
- // 其他验证错误
300
- return res.status(400).json(error.toJSON());
301
- }
302
-
303
- next(error);
304
- });
305
- ```
306
-
307
- ### 日志记录
308
-
309
- ```javascript
310
- app.use((error, req, res, next) => {
311
- if (error instanceof ValidationError) {
312
- // 记录验证错误日志
313
- logger.warn('Validation failed', {
314
- url: req.url,
315
- method: req.method,
316
- errors: error.errors,
317
- data: error.data
318
- });
319
-
320
- return res.status(error.statusCode).json(error.toJSON());
321
- }
322
-
323
- next(error);
324
- });
325
- ```
326
-
327
- ---
328
-
329
- ## 完整示例
330
-
331
- ### 用户注册 API
332
-
333
- ```javascript
334
- const express = require('express');
335
- const bcrypt = require('bcrypt');
336
- const { dsl, validateAsync, ValidationError, SchemaUtils } = require('schema-dsl');
337
-
338
- const app = express();
339
- app.use(express.json());
340
-
341
- // 基础用户 Schema
342
- const baseUserSchema = dsl({
343
- id: 'objectId!',
344
- username: 'string:3-32!',
345
- email: 'email!',
346
- password: 'string:8-32!',
347
- age: 'integer:18-120',
348
- createdAt: 'date',
349
- updatedAt: 'date'
350
- });
351
-
352
- // 注册 Schema(排除系统字段,严格模式)
353
- const registerSchema = SchemaUtils
354
- .omit(baseUserSchema, ['id', 'createdAt', 'updatedAt'])
355
- .strict();
356
-
357
- // 注册接口
358
- app.post('/register', async (req, res, next) => {
359
- try {
360
- // 1. 验证请求数据
361
- const data = await validateAsync(registerSchema, req.body);
362
-
363
- // 2. 检查用户是否存在
364
- const existingUser = await db.users.findOne({ email: data.email });
365
- if (existingUser) {
366
- return res.status(409).json({
367
- code: 'USER_EXISTS',
368
- message: '邮箱已被注册'
369
- });
370
- }
371
-
372
- // 3. 加密密码
373
- const hashedPassword = await bcrypt.hash(data.password, 10);
374
-
375
- // 4. 保存用户
376
- const user = await db.users.insert({
377
- ...data,
378
- password: hashedPassword,
379
- createdAt: new Date(),
380
- updatedAt: new Date()
381
- });
382
-
383
- // 5. 返回公开信息(移除密码)
384
- const publicSchema = SchemaUtils
385
- .omit(baseUserSchema, ['password'])
386
- .clean();
387
-
388
- const { validate } = require('schema-dsl');
389
- const result = validate(publicSchema, user);
390
-
391
- res.status(201).json({
392
- success: true,
393
- user: result.data
394
- });
395
-
396
- } catch (error) {
397
- next(error);
398
- }
399
- });
400
-
401
- // 全局错误处理
402
- app.use((error, req, res, next) => {
403
- if (error instanceof ValidationError) {
404
- return res.status(error.statusCode).json(error.toJSON());
405
- }
406
-
407
- console.error('Server error:', error);
408
- res.status(500).json({ error: 'Internal Server Error' });
409
- });
410
-
411
- app.listen(3000, () => {
412
- console.log('Server running on http://localhost:3000');
413
- });
414
- ```
415
-
416
- ---
417
-
418
- ## API 参考
419
-
420
- ### validateAsync(schema, data, options?)
421
-
422
- **参数**:
423
- - `schema` - JSON Schema 或 DslBuilder 实例
424
- - `data` - 待验证的数据
425
- - `options` - 验证选项(可选)
426
- - `locale` - 语言设置(如 'zh-CN', 'en-US')
427
- - `format` - 是否格式化错误(默认 true)
428
-
429
- **返回值**:
430
- - 验证通过:返回处理后的数据
431
- - 验证失败:抛出 `ValidationError`
432
-
433
- **示例**:
434
- ```javascript
435
- // 基础用法
436
- const data = await validateAsync(schema, inputData);
437
-
438
- // 指定语言
439
- const data = await validateAsync(schema, inputData, { locale: 'zh-CN' });
440
-
441
- // 不格式化错误
442
- const data = await validateAsync(schema, inputData, { format: false });
443
- ```
444
-
445
- ### ValidationError 类
446
-
447
- **构造函数**:
448
- ```javascript
449
- new ValidationError(errors, data)
450
- ```
451
-
452
- **属性**:
453
- - `name: 'ValidationError'`
454
- - `message: string` - 友好的错误消息
455
- - `errors: Array<Object>` - 原始错误列表
456
- - `data: any` - 原始输入数据
457
- - `statusCode: 400` - HTTP 状态码
458
-
459
- **方法**:
460
- - `toJSON()` - 转换为 JSON 格式
461
- - `getFieldError(field)` - 获取指定字段的错误
462
- - `getFieldErrors()` - 获取所有字段的错误映射
463
- - `hasFieldError(field)` - 检查字段是否有错误
464
- - `getErrorCount()` - 获取错误数量
465
-
466
- ---
467
-
468
- ## 相关文档
469
-
470
- - [SchemaUtils 链式调用](schema-utils-chaining.md) - Schema 复用简化方法
471
- - [validate.md](validate.md) - 传统同步验证方法
472
- - [error-handling.md](error-handling.md) - 错误处理指南
473
- - [Express 示例](../examples/express-integration.js) - 完整 Express 集成示例
474
-
475
- ---
476
-
477
- **版本**: v1.0.4
478
- **更新日期**: 2025-12-29
479
- **作者**: SchemaI-DSL Team
480
-
1
+ # validateAsync - 异步验证
2
+
3
+ > 验证失败自动抛出错误
4
+
5
+ ---
6
+
7
+ ## 快速开始
8
+
9
+ ```javascript
10
+ const { dsl, validateAsync } = require('schema-dsl');
11
+
12
+ const userSchema = dsl({
13
+ name: 'string!',
14
+ email: 'email!',
15
+ age: 'integer:18-120'
16
+ });
17
+
18
+ try {
19
+ const data = await validateAsync(userSchema, {
20
+ name: 'John',
21
+ email: 'john@example.com',
22
+ age: 30
23
+ });
24
+
25
+ console.log('验证成功:', data);
26
+ } catch (error) {
27
+ console.error('验证失败:', error.message);
28
+ }
29
+ ```
30
+
31
+ ---
32
+
33
+ ## 基础用法
34
+
35
+ ```javascript
36
+ try {
37
+ await validateAsync(userSchema, {
38
+ name: '',
39
+ email: 'invalid'
40
+ });
41
+ } catch (error) {
42
+ console.log(error instanceof ValidationError); // true
43
+ console.log(error.getFieldErrors());
44
+ // { email: '邮箱格式错误' }
45
+ // `string!` 只表示字段必填;若要限制空字符串,需要叠加长度约束。
46
+ }
47
+ ```
48
+
49
+ ---
50
+
51
+ ## ValidationError
52
+
53
+ ### 属性
54
+
55
+ ```javascript
56
+ class ValidationError extends Error {
57
+ name: 'ValidationError' // 错误名称
58
+ message: string // 友好的错误消息
59
+ errors: Array<Object> // 格式化后的错误项列表(path/message/keyword/...)
60
+ data: any // 原始输入数据
61
+ statusCode: 400 // HTTP 状态码
62
+ }
63
+ ```
64
+
65
+ ### 方法
66
+
67
+ #### 1. `toJSON()` - 转换为 JSON(用于 API 响应)
68
+
69
+ ```javascript
70
+ try {
71
+ await validateAsync(schema, data);
72
+ } catch (error) {
73
+ const json = error.toJSON();
74
+ // {
75
+ // error: 'ValidationError',
76
+ // message: 'Validation failed: name: 字段必填',
77
+ // statusCode: 400,
78
+ // details: [
79
+ // { field: 'name', message: '字段必填', keyword: 'required', params: {...} }
80
+ // ]
81
+ // }
82
+ }
83
+ ```
84
+
85
+ #### 2. `getFieldError(field)` - 获取指定字段的错误
86
+
87
+ ```javascript
88
+ try {
89
+ await validateAsync(schema, data);
90
+ } catch (error) {
91
+ const nameError = error.getFieldError('name');
92
+ console.log(nameError.message); // '字段必填'
93
+ }
94
+ ```
95
+
96
+ #### 3. `getFieldErrors()` - 获取所有字段的错误映射
97
+
98
+ ```javascript
99
+ try {
100
+ await validateAsync(schema, data);
101
+ } catch (error) {
102
+ const fieldErrors = error.getFieldErrors();
103
+ // { name: '字段必填', email: '邮箱格式错误' }
104
+ }
105
+ ```
106
+
107
+ #### 4. `hasFieldError(field)` - 检查字段是否有错误
108
+
109
+ ```javascript
110
+ try {
111
+ await validateAsync(schema, data);
112
+ } catch (error) {
113
+ if (error.hasFieldError('email')) {
114
+ console.log('邮箱格式错误');
115
+ }
116
+ }
117
+ ```
118
+
119
+ #### 5. `getErrorCount()` - 获取错误数量
120
+
121
+ ```javascript
122
+ try {
123
+ await validateAsync(schema, data);
124
+ } catch (error) {
125
+ console.log(`发现 ${error.getErrorCount()} 个错误`);
126
+ }
127
+ ```
128
+
129
+ ---
130
+
131
+ ## Express 集成
132
+
133
+ ### 基础集成
134
+
135
+ ```javascript
136
+ const express = require('express');
137
+ const { dsl, validateAsync, ValidationError } = require('schema-dsl');
138
+
139
+ const app = express();
140
+ app.use(express.json());
141
+
142
+ // 定义 Schema
143
+ const userSchema = dsl({
144
+ name: 'string:1-50!',
145
+ email: 'email!',
146
+ age: 'integer:18-120'
147
+ });
148
+
149
+ // 路由处理
150
+ app.post('/users', async (req, res, next) => {
151
+ try {
152
+ // 验证请求体
153
+ const validData = await validateAsync(userSchema, req.body);
154
+
155
+ // 保存到数据库
156
+ const user = await db.users.insert(validData);
157
+
158
+ res.status(201).json({ success: true, user });
159
+ } catch (error) {
160
+ next(error); // 传递给错误处理中间件
161
+ }
162
+ });
163
+
164
+ // 全局错误处理中间件
165
+ app.use((error, req, res, next) => {
166
+ if (error instanceof ValidationError) {
167
+ return res.status(error.statusCode).json(error.toJSON());
168
+ }
169
+
170
+ // 其他错误
171
+ res.status(500).json({ error: 'Internal Server Error' });
172
+ });
173
+
174
+ app.listen(3000);
175
+ ```
176
+
177
+ ### 完整 CRUD 示例
178
+
179
+ ```javascript
180
+ const { SchemaUtils } = require('schema-dsl');
181
+
182
+ // 定义完整 Schema
183
+ const fullUserSchema = dsl({
184
+ id: 'objectId!',
185
+ name: 'string:1-50!',
186
+ email: 'email!',
187
+ password: 'string:8-32!',
188
+ age: 'integer:18-120',
189
+ createdAt: 'date',
190
+ updatedAt: 'date'
191
+ });
192
+
193
+ // POST /users - 创建用户(排除系统字段)
194
+ const createSchema = SchemaUtils
195
+ .omit(fullUserSchema, ['id', 'createdAt', 'updatedAt']);
196
+
197
+ app.post('/users', async (req, res, next) => {
198
+ try {
199
+ const data = await validateAsync(createSchema, req.body);
200
+ const user = await db.users.insert({
201
+ ...data,
202
+ createdAt: new Date(),
203
+ updatedAt: new Date()
204
+ });
205
+ res.status(201).json(user);
206
+ } catch (error) {
207
+ next(error);
208
+ }
209
+ });
210
+
211
+ // GET /users/:id - 查询用户(业务层显式移除敏感字段)
212
+ const publicSchema = SchemaUtils
213
+ .pick(fullUserSchema, ['id', 'name', 'email', 'age', 'createdAt', 'updatedAt']);
214
+
215
+ app.get('/users/:id', async (req, res, next) => {
216
+ try {
217
+ const user = await db.users.findById(req.params.id);
218
+ const { password, ...publicUser } = user;
219
+ const { validate } = require('schema-dsl');
220
+ const result = validate(publicSchema, publicUser);
221
+ res.json(result.data);
222
+ } catch (error) {
223
+ next(error);
224
+ }
225
+ });
226
+
227
+ // PATCH /users/:id - 更新用户(部分验证)
228
+ const updateSchema = SchemaUtils
229
+ .pick(fullUserSchema, ['name', 'age'])
230
+ .partial();
231
+
232
+ app.patch('/users/:id', async (req, res, next) => {
233
+ try {
234
+ const data = await validateAsync(updateSchema, req.body);
235
+ const user = await db.users.updateById(req.params.id, {
236
+ ...data,
237
+ updatedAt: new Date()
238
+ });
239
+ res.json(user);
240
+ } catch (error) {
241
+ next(error);
242
+ }
243
+ });
244
+
245
+ // PUT /users/:id - 替换用户(排除系统字段)
246
+ const replaceSchema = SchemaUtils
247
+ .omit(fullUserSchema, ['id', 'createdAt', 'updatedAt']);
248
+
249
+ app.put('/users/:id', async (req, res, next) => {
250
+ try {
251
+ const data = await validateAsync(replaceSchema, req.body);
252
+ const user = await db.users.replaceById(req.params.id, {
253
+ ...data,
254
+ updatedAt: new Date()
255
+ });
256
+ res.json(user);
257
+ } catch (error) {
258
+ next(error);
259
+ }
260
+ });
261
+ ```
262
+
263
+ > ⚠️ `SchemaUtils` 当前只负责生成派生 Schema(如 `pick()` / `omit()` / `partial()` / `extend()`),不会自动删除运行时对象上的额外字段。返回公开响应时,请先在业务层显式投影数据,再用 `validate()` 校验投影结果。
264
+
265
+ ---
266
+
267
+ ## 错误处理
268
+
269
+ ### 自定义错误格式
270
+
271
+ ```javascript
272
+ app.use((error, req, res, next) => {
273
+ if (error instanceof ValidationError) {
274
+ // 自定义错误响应格式
275
+ return res.status(422).json({
276
+ code: 'VALIDATION_FAILED',
277
+ message: '数据验证失败',
278
+ timestamp: new Date().toISOString(),
279
+ fields: error.getFieldErrors()
280
+ });
281
+ }
282
+
283
+ next(error);
284
+ });
285
+ ```
286
+
287
+ ### 分类错误处理
288
+
289
+ ```javascript
290
+ app.use((error, req, res, next) => {
291
+ if (error instanceof ValidationError) {
292
+ const fieldErrors = error.getFieldErrors();
293
+
294
+ // 邮箱格式错误
295
+ if (error.hasFieldError('email')) {
296
+ return res.status(400).json({
297
+ code: 'INVALID_EMAIL',
298
+ message: '邮箱格式错误',
299
+ field: 'email'
300
+ });
301
+ }
302
+
303
+ // 其他验证错误
304
+ return res.status(400).json(error.toJSON());
305
+ }
306
+
307
+ next(error);
308
+ });
309
+ ```
310
+
311
+ ### 日志记录
312
+
313
+ ```javascript
314
+ app.use((error, req, res, next) => {
315
+ if (error instanceof ValidationError) {
316
+ // 记录验证错误日志
317
+ logger.warn('Validation failed', {
318
+ url: req.url,
319
+ method: req.method,
320
+ errors: error.errors,
321
+ data: error.data
322
+ });
323
+
324
+ return res.status(error.statusCode).json(error.toJSON());
325
+ }
326
+
327
+ next(error);
328
+ });
329
+ ```
330
+
331
+ ---
332
+
333
+ ## 完整示例
334
+
335
+ ### 用户注册 API
336
+
337
+ ```javascript
338
+ const express = require('express');
339
+ const bcrypt = require('bcrypt');
340
+ const { dsl, validateAsync, ValidationError, SchemaUtils } = require('schema-dsl');
341
+
342
+ const app = express();
343
+ app.use(express.json());
344
+
345
+ // 基础用户 Schema
346
+ const baseUserSchema = dsl({
347
+ id: 'objectId!',
348
+ username: 'string:3-32!',
349
+ email: 'email!',
350
+ password: 'string:8-32!',
351
+ age: 'integer:18-120',
352
+ createdAt: 'date',
353
+ updatedAt: 'date'
354
+ });
355
+
356
+ // 注册 Schema(排除系统字段)
357
+ const registerSchema = SchemaUtils
358
+ .omit(baseUserSchema, ['id', 'createdAt', 'updatedAt']);
359
+
360
+ // 注册接口
361
+ app.post('/register', async (req, res, next) => {
362
+ try {
363
+ // 1. 验证请求数据
364
+ const data = await validateAsync(registerSchema, req.body);
365
+
366
+ // 2. 检查用户是否存在
367
+ const existingUser = await db.users.findOne({ email: data.email });
368
+ if (existingUser) {
369
+ return res.status(409).json({
370
+ code: 'USER_EXISTS',
371
+ message: '邮箱已被注册'
372
+ });
373
+ }
374
+
375
+ // 3. 加密密码
376
+ const hashedPassword = await bcrypt.hash(data.password, 10);
377
+
378
+ // 4. 保存用户
379
+ const user = await db.users.insert({
380
+ ...data,
381
+ password: hashedPassword,
382
+ createdAt: new Date(),
383
+ updatedAt: new Date()
384
+ });
385
+
386
+ // 5. 返回公开信息(先显式投影,再按公开 Schema 校验)
387
+ const publicSchema = SchemaUtils
388
+ .pick(baseUserSchema, ['id', 'username', 'email', 'age', 'createdAt', 'updatedAt']);
389
+
390
+ const { password, ...publicUser } = user;
391
+
392
+ const { validate } = require('schema-dsl');
393
+ const result = validate(publicSchema, publicUser);
394
+
395
+ res.status(201).json({
396
+ success: true,
397
+ user: result.data
398
+ });
399
+
400
+ } catch (error) {
401
+ next(error);
402
+ }
403
+ });
404
+
405
+ // 全局错误处理
406
+ app.use((error, req, res, next) => {
407
+ if (error instanceof ValidationError) {
408
+ return res.status(error.statusCode).json(error.toJSON());
409
+ }
410
+
411
+ console.error('Server error:', error);
412
+ res.status(500).json({ error: 'Internal Server Error' });
413
+ });
414
+
415
+ app.listen(3000, () => {
416
+ console.log('Server running on http://localhost:3000');
417
+ });
418
+ ```
419
+
420
+ ---
421
+
422
+ ## API 参考
423
+
424
+ ### validateAsync(schema, data, options?)
425
+
426
+ **参数**:
427
+ - `schema` - JSON Schema 或 DslBuilder 实例
428
+ - `data` - 待验证的数据
429
+ - `options` - 验证选项(可选)
430
+ - `locale` - 语言设置(如 'zh-CN', 'en-US')
431
+ - `format` - 是否格式化错误(默认 true)
432
+
433
+ **返回值**:
434
+ - 验证通过:返回处理后的数据
435
+ - 验证失败:抛出 `ValidationError`
436
+
437
+ **示例**:
438
+ ```javascript
439
+ // 基础用法
440
+ const data = await validateAsync(schema, inputData);
441
+
442
+ // 指定语言
443
+ const data = await validateAsync(schema, inputData, { locale: 'zh-CN' });
444
+
445
+ // 不格式化错误
446
+ const data = await validateAsync(schema, inputData, { format: false });
447
+ ```
448
+
449
+ ### ValidationError
450
+
451
+ **构造函数**:
452
+ ```javascript
453
+ new ValidationError(errors, data)
454
+ ```
455
+
456
+ **属性**:
457
+ - `name: 'ValidationError'`
458
+ - `message: string` - 友好的错误消息
459
+ - `errors: Array<Object>` - 格式化后的错误项列表(如 `path`、`message`、`keyword`、`params`)
460
+ - `data: any` - 原始输入数据
461
+ - `statusCode: 400` - HTTP 状态码
462
+
463
+ **方法**:
464
+ - `toJSON()` - 转换为 JSON 格式
465
+ - `getFieldError(field)` - 获取指定字段的错误
466
+ - `getFieldErrors()` - 获取所有字段的错误映射
467
+ - `hasFieldError(field)` - 检查字段是否有错误
468
+ - `getErrorCount()` - 获取错误数量
469
+
470
+ ---
471
+
472
+ ## 相关文档
473
+
474
+ - [SchemaUtils 链式调用](schema-utils-chaining.md) - Schema 复用简化方法
475
+ - [validate.md](validate.md) - 传统同步验证方法
476
+ - [error-handling.md](error-handling.md) - 错误处理指南
477
+ - [validate-async 完整示例](https://github.com/vextjs/schema-dsl/blob/main/examples/docs/validate-async.ts) - 顶层 `validateAsync()`、`ValidationError` 与业务层异步检查示例
478
+
479
+ ---
480
+
481
+ ## 对应示例文件
482
+
483
+ **示例入口**: [validate-async.ts](https://github.com/vextjs/schema-dsl/blob/main/examples/docs/validate-async.ts)
484
+ **说明**: 覆盖 `validateAsync()` 的成功路径、`ValidationError` 捕获,以及“结构校验通过后再做业务层异步检查”的推荐方式。
485
+
486
+ ---
487
+
488
+ **版本**: v1.0.4
489
+ **更新日期**: 2025-12-29
490
+ **作者**: schema-dsl Team
491
+