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
package/docs/enum.md CHANGED
@@ -1,475 +1,482 @@
1
- # 枚举功能文档
2
-
3
- **版本**: v1.1.0
4
- **最后更新**: 2025-12-31
5
-
6
- ---
7
-
8
- ## 📖 概述
9
-
10
- 枚举(Enum)功能允许你定义字段只能取特定的值集合。schema-dsl 支持多种枚举类型和语法格式。
11
-
12
- ---
13
-
14
- ## ✨ 核心特性
15
-
16
- - ✅ **字符串枚举** - 限定字符串值范围
17
- - ✅ **布尔值枚举** - true/false 布尔值
18
- - ✅ **数字枚举** - 数字值限定
19
- - ✅ **整数枚举** - 整数值限定(禁止小数)
20
- - ✅ **小数枚举** - 支持小数值
21
- - ✅ **自动类型识别** - 智能识别枚举类型
22
- - ✅ **多种语法** - 简写和完整形式
23
- - ✅ **必填支持** - 枚举字段可标记为必填
24
- - ✅ **链式 API** - 支持 .label() 和 .messages()
25
-
26
- ---
27
-
28
- ## 📝 语法格式
29
-
30
- ### 基础语法
31
-
32
- ```javascript
33
- // 简写形式(自动识别类型)
34
- 'value1|value2|value3'
35
-
36
- // 完整形式(显式指定类型)
37
- 'enum:value1|value2|value3' // 字符串枚举
38
- 'enum:type:value1|value2|value3' // 指定类型的枚举
39
-
40
- // 必填标记
41
- 'value1|value2!'
42
- 'enum:type:value1|value2!'
43
- ```
44
-
45
- ### 支持的枚举类型
46
-
47
- | 类型 | 语法 | 示例 |
48
- |------|------|------|
49
- | 字符串 | `'value1\|value2'` | `'active\|inactive'` |
50
- | 字符串(显式) | `'enum:value1\|value2'` | `'enum:admin\|user'` |
51
- | 布尔值(自动) | `'true\|false'` | `'true\|false'` |
52
- | 布尔值(显式) | `'enum:boolean:true\|false'` | `'enum:boolean:true\|false'` |
53
- | 数字(自动) | `'1\|2\|3'` | `'1\|2\|3'` |
54
- | 数字(显式) | `'enum:number:1\|2\|3'` | `'enum:number:1\|2\|3'` |
55
- | 整数 | `'enum:integer:1\|2\|3'` | `'enum:integer:1\|2\|3'` |
56
- | 小数 | `'1.0\|1.5\|2.0'` | `'1.0\|1.5\|2.0'` |
57
-
58
- ---
59
-
60
- ## 🚀 快速开始
61
-
62
- ### 1. 字符串枚举
63
-
64
- ```javascript
65
- const { dsl, validate } = require('schema-dsl');
66
-
67
- // 简写形式
68
- const schema = dsl({
69
- status: 'active|inactive|pending'
70
- });
71
-
72
- // 验证
73
- validate(schema, { status: 'active' }); // ✅ 通过
74
- validate(schema, { status: 'unknown' }); // ❌ 失败
75
- ```
76
-
77
- ### 2. 布尔值枚举
78
-
79
- ```javascript
80
- // 自动识别为布尔值
81
- const schema = dsl({
82
- isPublic: 'true|false',
83
- verified: 'true|false!' // 必填
84
- });
85
-
86
- // 验证
87
- validate(schema, { isPublic: true, verified: false }); // ✅ 通过
88
- validate(schema, { isPublic: 'true' }); // ❌ 失败(字符串)
89
- ```
90
-
91
- ### 3. 数字枚举
92
-
93
- ```javascript
94
- // 自动识别为数字
95
- const schema = dsl({
96
- priority: '1|2|3',
97
- rating: '1.0|1.5|2.0|2.5' // 小数
98
- });
99
-
100
- // 验证
101
- validate(schema, { priority: 1, rating: 2.0 }); // ✅ 通过
102
- validate(schema, { priority: '1' }); // ❌ 失败(字符串)
103
- ```
104
-
105
- ---
106
-
107
- ## 📚 详细用法
108
-
109
- ### 必填枚举
110
-
111
- ```javascript
112
- const schema = dsl({
113
- // 字符串枚举必填
114
- role: 'admin|user|guest!',
115
-
116
- // 布尔值枚举必填
117
- agreeTerms: 'true|false!',
118
-
119
- // 数字枚举必填
120
- level: '1|2|3!'
121
- });
122
-
123
- // 缺失必填字段
124
- validate(schema, {}); // ❌ 失败
125
- ```
126
-
127
- ### 显式指定类型
128
-
129
- ```javascript
130
- const schema = dsl({
131
- // 显式指定字符串
132
- status: 'enum:active|inactive',
133
-
134
- // 显式指定布尔值
135
- flag: 'enum:boolean:true|false',
136
-
137
- // 显式指定数字
138
- priority: 'enum:number:1|2|3',
139
-
140
- // 显式指定整数(禁止小数)
141
- level: 'enum:integer:1|2|3'
142
- });
143
- ```
144
-
145
- ### 链式 API
146
-
147
- ```javascript
148
- const schema = dsl({
149
- status: dsl('active|inactive|archived')
150
- .label('文章状态')
151
- .messages({
152
- 'string.enum': '状态必须是: 草稿、已发布或已归档'
153
- })
154
- });
155
- ```
156
-
157
- ### 数组中的枚举
158
-
159
- ```javascript
160
- const schema = dsl({
161
- tags: 'array<enum:tech|business|lifestyle>',
162
- permissions: 'array<enum:read|write|delete>'
163
- });
164
-
165
- validate(schema, {
166
- tags: ['tech', 'business'],
167
- permissions: ['read', 'write']
168
- }); // ✅ 通过
169
- ```
170
-
171
- ### 嵌套对象中的枚举
172
-
173
- ```javascript
174
- const schema = dsl({
175
- user: {
176
- name: 'string!',
177
- role: 'admin|user|guest',
178
- status: 'active|inactive'
179
- },
180
- settings: {
181
- theme: 'light|dark|auto',
182
- language: 'en|zh-CN|ja'
183
- }
184
- });
185
- ```
186
-
187
- ---
188
-
189
- ## 🎯 实际应用场景
190
-
191
- ### 用户管理系统
192
-
193
- ```javascript
194
- const userSchema = dsl({
195
- username: 'string:3-32!',
196
- email: 'email!',
197
- role: 'admin|moderator|user|guest!',
198
- status: 'active|inactive|suspended|banned',
199
- emailVerified: 'true|false',
200
- permissionLevel: '0|1|2|3|4|5'.default(0),
201
- preferences: {
202
- theme: 'light|dark|auto',
203
- language: 'en|zh-CN|zh-TW|ja|ko',
204
- notifications: 'all|mentions|none'
205
- }
206
- });
207
- ```
208
-
209
- ### 订单管理
210
-
211
- ```javascript
212
- const orderSchema = dsl({
213
- orderId: 'string!',
214
- status: 'pending|processing|completed|cancelled!',
215
- priority: '1|2|3'.default(2),
216
- payment: {
217
- method: 'card|paypal|crypto!',
218
- status: 'pending|success|failed!'
219
- }
220
- });
221
- ```
222
-
223
- ### 内容管理
224
-
225
- ```javascript
226
- const postSchema = dsl({
227
- title: 'string:5-100!',
228
- status: 'draft|published|archived!',
229
- visibility: 'public|private|unlisted',
230
- category: 'tech|business|lifestyle|education'
231
- });
232
- ```
233
-
234
- ---
235
-
236
- ## ⚙️ 高级特性
237
-
238
- ### 默认值
239
-
240
- ```javascript
241
- const schema = dsl({
242
- theme: 'light|dark|auto'.default('auto'),
243
- language: 'en|zh-CN'.default('en')
244
- });
245
- ```
246
-
247
- ### 自定义错误消息
248
-
249
- #### 统一使用 'enum' 键(推荐)✅
250
-
251
- 所有枚举类型统一使用 `'enum'` 定义错误消息,最简单直接:
252
-
253
- ```javascript
254
- // 字符串枚举
255
- const schema = dsl({
256
- status: dsl('active|inactive|pending').messages({
257
- 'enum': '状态必须是: 激活、未激活或待处理'
258
- })
259
- });
260
-
261
- // 布尔值枚举
262
- const schema = dsl({
263
- isActive: dsl('true|false').messages({
264
- 'enum': '必须是 true 或 false'
265
- })
266
- });
267
-
268
- // 数字枚举
269
- const schema = dsl({
270
- priority: dsl('1|2|3').messages({
271
- 'enum': '优先级必须是 1、2 或 3'
272
- })
273
- });
274
-
275
- // 整数枚举
276
- const schema = dsl({
277
- level: dsl('enum:integer:1|2|3').messages({
278
- 'enum': '等级必须是 1、2 或 3'
279
- })
280
- });
281
- ```
282
-
283
- **说明**:
284
- - ✅ 所有枚举类型统一使用 `'enum'` 键
285
- - ✅ 简单易懂,不需要记忆不同类型的键名
286
- - ✅ 自动推断类型,用户只关心错误提示内容
287
-
288
- #### 高级用法:按类型定制消息(可选)
289
-
290
- 如果需要为不同类型的枚举定制不同的错误消息,可以使用 `type.enum` 格式:
291
-
292
- ```javascript
293
- const schema = dsl({
294
- status: dsl('active|inactive').messages({
295
- 'string.enum': '字符串枚举错误' // 字符串枚举专用
296
- }),
297
- priority: dsl('1|2|3').messages({
298
- 'number.enum': '数字枚举错误' // 数字枚举专用
299
- }),
300
- flag: dsl('true|false').messages({
301
- 'boolean.enum': '布尔枚举错误' // 布尔枚举专用
302
- })
303
- });
304
- ```
305
-
306
- **优先级**: `type.enum` > `enum` > 全局默认
307
-
308
- **建议**: 99% 的场景直接使用 `'enum'` 就够了 ✅
309
-
310
- ### 多语言支持
311
-
312
- ```javascript
313
- dsl.config({
314
- i18n: {
315
- 'zh-CN': {
316
- 'field.status': '状态',
317
- 'enum.status': '状态必须是: 激活、未激活或待处理'
318
- }
319
- }
320
- });
321
-
322
- const schema = dsl({
323
- status: dsl('active|inactive|pending').label('field.status')
324
- });
325
- ```
326
-
327
- ---
328
-
329
- ## 🔍 类型识别规则
330
-
331
- ### 自动识别逻辑
332
-
333
- ```javascript
334
- // 1. 所有值都是 'true' 或 'false' → 布尔值枚举
335
- 'true|false' → { type: 'boolean', enum: [true, false] }
336
-
337
- // 2. 所有值都是数字 → 数字枚举
338
- '1|2|3' → { type: 'number', enum: [1, 2, 3] }
339
-
340
- // 3. 包含小数 → 数字枚举
341
- '1.0|1.5|2.0' → { type: 'number', enum: [1.0, 1.5, 2.0] }
342
-
343
- // 4. 其他情况 → 字符串枚举
344
- 'active|inactive' → { type: 'string', enum: ['active', 'inactive'] }
345
- ```
346
-
347
- ### 显式指定类型
348
-
349
- ```javascript
350
- // 强制字符串类型(即使值看起来像数字)
351
- 'enum:string:1|2|3' → { type: 'string', enum: ['1', '2', '3'] }
352
-
353
- // 强制布尔值类型
354
- 'enum:boolean:true|false' → { type: 'boolean', enum: [true, false] }
355
-
356
- // 强制数字类型
357
- 'enum:number:1|2|3' → { type: 'number', enum: [1, 2, 3] }
358
-
359
- // 强制整数类型(禁止小数)
360
- 'enum:integer:1|2|3' → { type: 'integer', enum: [1, 2, 3] }
361
- ```
362
-
363
- ---
364
-
365
- ## ❌ 错误处理
366
-
367
- ### 无效的枚举值
368
-
369
- ```javascript
370
- // 布尔值枚举只接受 'true' 和 'false'
371
- try {
372
- dsl({ flag: 'enum:boolean:true|false|maybe' });
373
- } catch (error) {
374
- // Error: Invalid boolean enum value: maybe
375
- }
376
-
377
- // 数字枚举只接受数字
378
- try {
379
- dsl({ value: 'enum:number:1|2|abc' });
380
- } catch (error) {
381
- // Error: Invalid number enum value: abc
382
- }
383
- ```
384
-
385
- ### 类型不匹配
386
-
387
- 枚举会自动进行类型验证:
388
-
389
- ```javascript
390
- const schema = dsl({ priority: '1|2|3' });
391
-
392
- // 错误:传入字符串
393
- validate(schema, { priority: '1' });
394
- // ❌ 失败: priority 必须是数字类型(自动类型检查)
395
-
396
- // 错误:传入超出范围的数字
397
- validate(schema, { priority: 999 });
398
- // ❌ 失败: priority 必须是以下值之一: 1, 2, 3(枚举检查)
399
- ```
400
-
401
- **说明**:
402
- - 类型错误由 schema 自动验证(如传入字符串给数字枚举)
403
- - 枚举范围错误统一使用 `'enum'` 错误消息
404
-
405
- ---
406
-
407
- ## 📊 性能
408
-
409
- 枚举验证性能优异:
410
-
411
- ```javascript
412
- const schema = dsl({
413
- status: 'active|inactive|pending',
414
- priority: '1|2|3',
415
- flag: 'true|false'
416
- });
417
-
418
- // 性能测试:10,000 次验证
419
- // 平均每秒验证: 270,000+ 次
420
- ```
421
-
422
- ---
423
-
424
- ## 🔄 兼容性
425
-
426
- ### 与旧版本兼容
427
-
428
- ```javascript
429
- // v1.0.x 语法(仍然支持)
430
- 'value1|value2|value3'
431
-
432
- // v1.1.0 新增语法
433
- 'enum:value1|value2|value3'
434
- 'enum:type:value1|value2|value3'
435
- ```
436
-
437
- ### 不影响其他类型
438
-
439
- ```javascript
440
- // 带冒号的其他类型不受影响
441
- const schema = dsl({
442
- username: 'string:3-32', // ✅ 正常工作
443
- age: 'number:18-120', // ✅ 正常工作
444
- phone: 'phone:cn', // ✅ 正常工作
445
- status: 'active|inactive' // ✅ 枚举正常工作
446
- });
447
- ```
448
-
449
- ---
450
-
451
- ## 📖 相关文档
452
-
453
- - [基础用法](./README.md)
454
- - [验证规则](./docs/validation.md)
455
- - [API 参考](./docs/api.md)
456
- - [示例代码](../examples/enum.examples.js)
457
-
458
- ---
459
-
460
- ## 🆕 更新日志
461
-
462
- ### v1.1.0 (2025-12-31)
463
-
464
- - ✨ 新增枚举功能
465
- - ✨ 支持字符串、布尔值、数字、整数枚举
466
- - ✨ 支持 `enum:` 前缀语法
467
- - 支持 `enum:type:values` 格式
468
- - ✨ 自动类型识别
469
- - 支持枚举必填标记
470
-
471
- ---
472
-
473
- **文档生成时间**: 2025-12-31
474
- **版本**: v1.1.0
475
-
1
+ # 枚举功能文档
2
+
3
+ **版本**: v1.1.0
4
+ **最后更新**: 2025-12-31
5
+
6
+ ---
7
+
8
+ ## 📖 概述
9
+
10
+ 枚举(Enum)功能允许你定义字段只能取特定的值集合。schema-dsl 支持多种枚举类型和语法格式。
11
+
12
+ ---
13
+
14
+ ## ✨ 核心特性
15
+
16
+ - ✅ **字符串枚举** - 限定字符串值范围
17
+ - ✅ **布尔值枚举** - true/false 布尔值
18
+ - ✅ **数字枚举** - 数字值限定
19
+ - ✅ **整数枚举** - 整数值限定(禁止小数)
20
+ - ✅ **小数枚举** - 支持小数值
21
+ - ✅ **自动类型识别** - 智能识别枚举类型
22
+ - ✅ **多种语法** - 简写和完整形式
23
+ - ✅ **必填支持** - 枚举字段可标记为必填
24
+ - ✅ **链式 API** - 支持 .label() 和 .messages()
25
+
26
+ ---
27
+
28
+ ## 📝 语法格式
29
+
30
+ ### 基础语法
31
+
32
+ ```javascript
33
+ // 简写形式(自动识别类型)
34
+ 'value1|value2|value3'
35
+
36
+ // 完整形式(显式指定类型)
37
+ 'enum:value1|value2|value3' // 字符串枚举
38
+ 'enum:type:value1|value2|value3' // 指定类型的枚举
39
+
40
+ // 必填标记
41
+ 'value1|value2!'
42
+ 'enum:type:value1|value2!'
43
+ ```
44
+
45
+ ### 支持的枚举类型
46
+
47
+ | 类型 | 语法 | 示例 |
48
+ |------|------|------|
49
+ | 字符串 | `'value1\|value2'` | `'active\|inactive'` |
50
+ | 字符串(显式) | `'enum:value1\|value2'` | `'enum:admin\|user'` |
51
+ | 布尔值(自动) | `'true\|false'` | `'true\|false'` |
52
+ | 布尔值(显式) | `'enum:boolean:true\|false'` | `'enum:boolean:true\|false'` |
53
+ | 数字(自动) | `'1\|2\|3'` | `'1\|2\|3'` |
54
+ | 数字(显式) | `'enum:number:1\|2\|3'` | `'enum:number:1\|2\|3'` |
55
+ | 整数 | `'enum:integer:1\|2\|3'` | `'enum:integer:1\|2\|3'` |
56
+ | 小数 | `'1.0\|1.5\|2.0'` | `'1.0\|1.5\|2.0'` |
57
+
58
+ ---
59
+
60
+ ## 🚀 快速开始
61
+
62
+ ### 1. 字符串枚举
63
+
64
+ ```javascript
65
+ const { dsl, validate } = require('schema-dsl');
66
+
67
+ // 简写形式
68
+ const schema = dsl({
69
+ status: 'active|inactive|pending'
70
+ });
71
+
72
+ // 验证
73
+ validate(schema, { status: 'active' }); // ✅ 通过
74
+ validate(schema, { status: 'unknown' }); // ❌ 失败
75
+ ```
76
+
77
+ ### 2. 布尔值枚举
78
+
79
+ ```javascript
80
+ // 自动识别为布尔值
81
+ const schema = dsl({
82
+ isPublic: 'true|false',
83
+ verified: 'true|false!' // 必填
84
+ });
85
+
86
+ // 验证
87
+ validate(schema, { isPublic: true, verified: false }); // ✅ 通过
88
+ validate(schema, { isPublic: 'true' }); // ❌ 失败(字符串)
89
+ ```
90
+
91
+ ### 3. 数字枚举
92
+
93
+ ```javascript
94
+ // 自动识别为数字
95
+ const schema = dsl({
96
+ priority: '1|2|3',
97
+ rating: '1.0|1.5|2.0|2.5' // 小数
98
+ });
99
+
100
+ // 验证
101
+ validate(schema, { priority: 1, rating: 2.0 }); // ✅ 通过
102
+ validate(schema, { priority: '1' }); // ❌ 失败(字符串)
103
+ ```
104
+
105
+ ---
106
+
107
+ ## 📚 详细用法
108
+
109
+ ### 必填枚举
110
+
111
+ ```javascript
112
+ const schema = dsl({
113
+ // 字符串枚举必填
114
+ role: 'admin|user|guest!',
115
+
116
+ // 布尔值枚举必填
117
+ agreeTerms: 'true|false!',
118
+
119
+ // 数字枚举必填
120
+ level: '1|2|3!'
121
+ });
122
+
123
+ // 缺失必填字段
124
+ validate(schema, {}); // ❌ 失败
125
+ ```
126
+
127
+ ### 显式指定类型
128
+
129
+ ```javascript
130
+ const schema = dsl({
131
+ // 显式指定字符串
132
+ status: 'enum:active|inactive',
133
+
134
+ // 显式指定布尔值
135
+ flag: 'enum:boolean:true|false',
136
+
137
+ // 显式指定数字
138
+ priority: 'enum:number:1|2|3',
139
+
140
+ // 显式指定整数(禁止小数)
141
+ level: 'enum:integer:1|2|3'
142
+ });
143
+ ```
144
+
145
+ ### 链式 API
146
+
147
+ ```javascript
148
+ const schema = dsl({
149
+ status: dsl('active|inactive|archived')
150
+ .label('文章状态')
151
+ .messages({
152
+ 'string.enum': '状态必须是: 草稿、已发布或已归档'
153
+ })
154
+ });
155
+ ```
156
+
157
+ ### 数组中的枚举
158
+
159
+ ```javascript
160
+ const schema = dsl({
161
+ tags: 'array<enum:tech|business|lifestyle>',
162
+ permissions: 'array<enum:read|write|delete>'
163
+ });
164
+
165
+ validate(schema, {
166
+ tags: ['tech', 'business'],
167
+ permissions: ['read', 'write']
168
+ }); // ✅ 通过
169
+ ```
170
+
171
+ ### 嵌套对象中的枚举
172
+
173
+ ```javascript
174
+ const schema = dsl({
175
+ user: {
176
+ name: 'string!',
177
+ role: 'admin|user|guest',
178
+ status: 'active|inactive'
179
+ },
180
+ settings: {
181
+ theme: 'light|dark|auto',
182
+ language: 'en|zh-CN|ja'
183
+ }
184
+ });
185
+ ```
186
+
187
+ ---
188
+
189
+ ## 🎯 实际应用场景
190
+
191
+ ### 用户管理系统
192
+
193
+ ```javascript
194
+ const userSchema = dsl({
195
+ username: 'string:3-32!',
196
+ email: 'email!',
197
+ role: 'admin|moderator|user|guest!',
198
+ status: 'active|inactive|suspended|banned',
199
+ emailVerified: 'true|false',
200
+ permissionLevel: '0|1|2|3|4|5'.default(0),
201
+ preferences: {
202
+ theme: 'light|dark|auto',
203
+ language: 'en|zh-CN|zh-TW|ja|ko',
204
+ notifications: 'all|mentions|none'
205
+ }
206
+ });
207
+ ```
208
+
209
+ ### 订单管理
210
+
211
+ ```javascript
212
+ const orderSchema = dsl({
213
+ orderId: 'string!',
214
+ status: 'pending|processing|completed|cancelled!',
215
+ priority: '1|2|3'.default(2),
216
+ payment: {
217
+ method: 'card|paypal|crypto!',
218
+ status: 'pending|success|failed!'
219
+ }
220
+ });
221
+ ```
222
+
223
+ ### 内容管理
224
+
225
+ ```javascript
226
+ const postSchema = dsl({
227
+ title: 'string:5-100!',
228
+ status: 'draft|published|archived!',
229
+ visibility: 'public|private|unlisted',
230
+ category: 'tech|business|lifestyle|education'
231
+ });
232
+ ```
233
+
234
+ ---
235
+
236
+ ## ⚙️ 高级特性
237
+
238
+ ### 默认值
239
+
240
+ ```javascript
241
+ const schema = dsl({
242
+ theme: 'light|dark|auto'.default('auto'),
243
+ language: 'en|zh-CN'.default('en')
244
+ });
245
+ ```
246
+
247
+ ### 自定义错误消息
248
+
249
+ #### 统一使用 'enum' 键(推荐)✅
250
+
251
+ 所有枚举类型统一使用 `'enum'` 定义错误消息,最简单直接:
252
+
253
+ ```javascript
254
+ // 字符串枚举
255
+ const schema = dsl({
256
+ status: dsl('active|inactive|pending').messages({
257
+ 'enum': '状态必须是: 激活、未激活或待处理'
258
+ })
259
+ });
260
+
261
+ // 布尔值枚举
262
+ const schema = dsl({
263
+ isActive: dsl('true|false').messages({
264
+ 'enum': '必须是 true 或 false'
265
+ })
266
+ });
267
+
268
+ // 数字枚举
269
+ const schema = dsl({
270
+ priority: dsl('1|2|3').messages({
271
+ 'enum': '优先级必须是 1、2 或 3'
272
+ })
273
+ });
274
+
275
+ // 整数枚举
276
+ const schema = dsl({
277
+ level: dsl('enum:integer:1|2|3').messages({
278
+ 'enum': '等级必须是 1、2 或 3'
279
+ })
280
+ });
281
+ ```
282
+
283
+ **说明**:
284
+ - ✅ 所有枚举类型统一使用 `'enum'` 键
285
+ - ✅ 简单易懂,不需要记忆不同类型的键名
286
+ - ✅ 自动推断类型,用户只关心错误提示内容
287
+
288
+ #### 高级用法:按类型定制消息(可选)
289
+
290
+ 如果需要为不同类型的枚举定制不同的错误消息,可以使用 `type.enum` 格式:
291
+
292
+ ```javascript
293
+ const schema = dsl({
294
+ status: dsl('active|inactive').messages({
295
+ 'string.enum': '字符串枚举错误' // 字符串枚举专用
296
+ }),
297
+ priority: dsl('1|2|3').messages({
298
+ 'number.enum': '数字枚举错误' // 数字枚举专用
299
+ }),
300
+ flag: dsl('true|false').messages({
301
+ 'boolean.enum': '布尔枚举错误' // 布尔枚举专用
302
+ })
303
+ });
304
+ ```
305
+
306
+ **优先级**: `type.enum` > `enum` > 全局默认
307
+
308
+ **建议**: 99% 的场景直接使用 `'enum'` 就够了 ✅
309
+
310
+ ### 多语言支持
311
+
312
+ ```javascript
313
+ dsl.config({
314
+ i18n: {
315
+ 'zh-CN': {
316
+ 'field.status': '状态',
317
+ 'enum.status': '状态必须是: 激活、未激活或待处理'
318
+ }
319
+ }
320
+ });
321
+
322
+ const schema = dsl({
323
+ status: dsl('active|inactive|pending').label('field.status')
324
+ });
325
+ ```
326
+
327
+ ---
328
+
329
+ ## 🔍 类型识别规则
330
+
331
+ ### 自动识别逻辑
332
+
333
+ ```javascript
334
+ // 1. 所有值都是 'true' 或 'false' → 布尔值枚举
335
+ 'true|false' → { type: 'boolean', enum: [true, false] }
336
+
337
+ // 2. 所有值都是数字 → 数字枚举
338
+ '1|2|3' → { type: 'number', enum: [1, 2, 3] }
339
+
340
+ // 3. 包含小数 → 数字枚举
341
+ '1.0|1.5|2.0' → { type: 'number', enum: [1.0, 1.5, 2.0] }
342
+
343
+ // 4. 其他情况 → 字符串枚举
344
+ 'active|inactive' → { type: 'string', enum: ['active', 'inactive'] }
345
+ ```
346
+
347
+ ### 显式指定类型
348
+
349
+ ```javascript
350
+ // 强制字符串类型(即使值看起来像数字)
351
+ 'enum:string:1|2|3' → { type: 'string', enum: ['1', '2', '3'] }
352
+
353
+ // 强制布尔值类型
354
+ 'enum:boolean:true|false' → { type: 'boolean', enum: [true, false] }
355
+
356
+ // 强制数字类型
357
+ 'enum:number:1|2|3' → { type: 'number', enum: [1, 2, 3] }
358
+
359
+ // 强制整数类型(禁止小数)
360
+ 'enum:integer:1|2|3' → { type: 'integer', enum: [1, 2, 3] }
361
+ ```
362
+
363
+ ---
364
+
365
+ ## ❌ 错误处理
366
+
367
+ ### 无效的枚举值
368
+
369
+ ```javascript
370
+ // 布尔值枚举只接受 'true' 和 'false'
371
+ try {
372
+ dsl({ flag: 'enum:boolean:true|false|maybe' });
373
+ } catch (error) {
374
+ // Error: Invalid boolean enum value: maybe
375
+ }
376
+
377
+ // 数字枚举只接受数字
378
+ try {
379
+ dsl({ value: 'enum:number:1|2|abc' });
380
+ } catch (error) {
381
+ // Error: Invalid number enum value: abc
382
+ }
383
+ ```
384
+
385
+ ### 类型不匹配
386
+
387
+ 枚举会自动进行类型验证:
388
+
389
+ ```javascript
390
+ const schema = dsl({ priority: '1|2|3' });
391
+
392
+ // 错误:传入字符串
393
+ validate(schema, { priority: '1' });
394
+ // ❌ 失败: priority 必须是数字类型(自动类型检查)
395
+
396
+ // 错误:传入超出范围的数字
397
+ validate(schema, { priority: 999 });
398
+ // ❌ 失败: priority 必须是以下值之一: 1, 2, 3(枚举检查)
399
+ ```
400
+
401
+ **说明**:
402
+ - 类型错误由 schema 自动验证(如传入字符串给数字枚举)
403
+ - 枚举范围错误统一使用 `'enum'` 错误消息
404
+
405
+ ---
406
+
407
+ ## 📊 性能
408
+
409
+ 枚举验证性能优异:
410
+
411
+ ```javascript
412
+ const schema = dsl({
413
+ status: 'active|inactive|pending',
414
+ priority: '1|2|3',
415
+ flag: 'true|false'
416
+ });
417
+
418
+ // 性能测试:10,000 次验证
419
+ // 平均每秒验证: 270,000+ 次
420
+ ```
421
+
422
+ ---
423
+
424
+ ## 🔄 兼容性
425
+
426
+ ### 与旧版本兼容
427
+
428
+ ```javascript
429
+ // v1.0.x 语法(仍然支持)
430
+ 'value1|value2|value3'
431
+
432
+ // v1.1.0 新增语法
433
+ 'enum:value1|value2|value3'
434
+ 'enum:type:value1|value2|value3'
435
+ ```
436
+
437
+ ### 不影响其他类型
438
+
439
+ ```javascript
440
+ // 带冒号的其他类型不受影响
441
+ const schema = dsl({
442
+ username: 'string:3-32', // ✅ 正常工作
443
+ age: 'number:18-120', // ✅ 正常工作
444
+ phone: 'phone:cn', // ✅ 正常工作
445
+ status: 'active|inactive' // ✅ 枚举正常工作
446
+ });
447
+ ```
448
+
449
+ ---
450
+
451
+ ## 📖 相关文档
452
+
453
+ - [基础用法](https://github.com/vextjs/schema-dsl/blob/main/README.md)
454
+ - [验证规则](./validation-guide.md)
455
+ - [API 参考](./api-reference.md)
456
+ - [示例代码](https://github.com/vextjs/schema-dsl/blob/main/examples/docs/enum.ts)
457
+
458
+ ---
459
+
460
+ ## 对应示例文件
461
+
462
+ **示例入口**: [enum.ts](https://github.com/vextjs/schema-dsl/blob/main/examples/docs/enum.ts)
463
+ **说明**: 覆盖字符串、数字、布尔值和数组元素枚举的成功/失败路径,并展示自定义枚举错误消息。
464
+
465
+ ---
466
+
467
+ ## 🆕 更新日志
468
+
469
+ ### v1.1.0 (2025-12-31)
470
+
471
+ - ✨ 新增枚举功能
472
+ - ✨ 支持字符串、布尔值、数字、整数枚举
473
+ - ✨ 支持 `enum:` 前缀语法
474
+ - ✨ 支持 `enum:type:values` 格式
475
+ - ✨ 自动类型识别
476
+ - ✨ 支持枚举必填标记
477
+
478
+ ---
479
+
480
+ **文档生成时间**: 2026-05-08
481
+ **版本**: v1.1.0
482
+