schema-dsl 1.2.4 → 2.0.0
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 +87 -210
- package/README.md +391 -2249
- package/dist/DslBuilder-DQDN0ZxZ.d.cts +341 -0
- package/dist/DslBuilder-DkLaOo9Q.d.ts +341 -0
- package/dist/Validator-C7GsVQOH.d.cts +192 -0
- package/dist/Validator-hFWKGxir.d.ts +192 -0
- package/dist/index.cjs +6594 -0
- package/dist/index.d.cts +1145 -0
- package/dist/index.d.ts +1145 -0
- package/dist/index.js +6528 -0
- package/dist/plugin-CIKtTMtS.d.cts +246 -0
- package/dist/plugin-CIKtTMtS.d.ts +246 -0
- package/dist/plugins/custom-format.cjs +3802 -0
- package/dist/plugins/custom-format.d.cts +12 -0
- package/dist/plugins/custom-format.d.ts +12 -0
- package/dist/plugins/custom-format.js +3772 -0
- package/dist/plugins/custom-type-example.cjs +3795 -0
- package/dist/plugins/custom-type-example.d.cts +8 -0
- package/dist/plugins/custom-type-example.d.ts +8 -0
- package/dist/plugins/custom-type-example.js +3765 -0
- package/dist/plugins/custom-validator.cjs +146 -0
- package/dist/plugins/custom-validator.d.cts +10 -0
- package/dist/plugins/custom-validator.d.ts +10 -0
- package/dist/plugins/custom-validator.js +121 -0
- package/docs/FEATURE-INDEX.md +102 -68
- package/docs/add-custom-locale.md +48 -35
- package/docs/add-keyword.md +24 -0
- package/docs/api-reference.md +396 -154
- package/docs/api.md +13 -0
- package/docs/best-practices-project-structure.md +19 -10
- package/docs/best-practices.md +93 -53
- package/docs/cache-manager.md +23 -15
- package/docs/compile.md +45 -0
- package/docs/conditional-api.md +40 -11
- package/docs/custom-extensions-guide.md +80 -152
- package/docs/design-philosophy.md +76 -71
- package/docs/doc-index.md +324 -0
- package/docs/dsl-syntax.md +69 -19
- package/docs/dynamic-locale.md +24 -14
- package/docs/enum.md +12 -5
- package/docs/error-handling.md +53 -44
- package/docs/export-guide.md +47 -8
- package/docs/export-limitations.md +27 -11
- package/docs/faq.md +86 -67
- package/docs/frontend-i18n-guide.md +26 -12
- package/docs/i18n-user-guide.md +60 -47
- package/docs/i18n.md +51 -32
- package/docs/index.md +48 -0
- package/docs/json-schema-basics.md +40 -0
- package/docs/label-vs-description.md +12 -3
- package/docs/markdown-exporter.md +15 -6
- package/docs/mongodb-exporter.md +11 -4
- package/docs/multi-language.md +26 -0
- package/docs/multi-type-support.md +26 -33
- package/docs/mysql-exporter.md +9 -2
- package/docs/number-operators.md +12 -5
- package/docs/optional-marker-guide.md +28 -23
- package/docs/performance-guide.md +49 -0
- package/docs/plugin-system.md +205 -366
- package/docs/plugin-type-registration.md +34 -0
- package/docs/postgresql-exporter.md +9 -2
- package/docs/public/favicon.svg +5 -0
- package/docs/quick-start.md +37 -363
- package/docs/runtime-locale-support.md +20 -9
- package/docs/schema-helper.md +10 -5
- package/docs/schema-utils-advanced-issues.md +23 -0
- package/docs/schema-utils-best-practices.md +20 -0
- package/docs/schema-utils-chaining.md +7 -0
- package/docs/schema-utils.md +76 -42
- package/docs/security-checklist.md +20 -0
- package/docs/string-extensions.md +17 -9
- package/docs/troubleshooting.md +36 -21
- package/docs/type-converter.md +41 -50
- package/docs/type-reference.md +38 -15
- package/docs/typescript-guide.md +53 -42
- package/docs/union-type-guide.md +11 -1
- package/docs/union-types.md +10 -3
- package/docs/validate-async.md +36 -25
- package/docs/validate-batch.md +49 -0
- package/docs/validate-dsl-object-support.md +33 -28
- package/docs/validate.md +36 -16
- package/docs/validation-guide.md +25 -7
- package/docs/validator.md +39 -0
- package/package.json +85 -27
- package/plugins/custom-format.cjs +8 -0
- package/plugins/custom-type-example.cjs +8 -0
- package/plugins/custom-validator.cjs +8 -0
- package/src/adapters/DslAdapter.ts +111 -0
- package/src/adapters/index.ts +1 -0
- package/src/config/constants.ts +83 -0
- package/src/config/index.ts +2 -0
- package/src/config/patterns.ts +77 -0
- package/src/core/CacheManager.ts +159 -0
- package/src/core/ConditionalBuilder.ts +382 -0
- package/src/core/ConditionalRuntime.ts +28 -0
- package/src/core/ConditionalValidator.ts +255 -0
- package/src/core/DslBuilder.ts +677 -0
- package/src/core/ErrorCodes.ts +38 -0
- package/src/core/ErrorFormatter.ts +271 -0
- package/src/core/JSONSchemaCore.ts +65 -0
- package/src/core/Locale.ts +187 -0
- package/src/core/MessageTemplate.ts +42 -0
- package/src/core/ObjectDslBuilder.ts +64 -0
- package/src/core/PluginManager.ts +326 -0
- package/src/core/StringExtensions.ts +140 -0
- package/src/core/TemplateEngine.ts +44 -0
- package/src/core/Validator.ts +448 -0
- package/src/errors/I18nError.ts +159 -0
- package/src/errors/ValidationError.ts +105 -0
- package/src/exporters/BaseExporter.ts +60 -0
- package/src/exporters/MarkdownExporter.ts +305 -0
- package/src/exporters/MongoDBExporter.ts +126 -0
- package/src/exporters/MySQLExporter.ts +155 -0
- package/src/exporters/PostgreSQLExporter.ts +222 -0
- package/src/exporters/index.ts +18 -0
- package/src/index.ts +633 -0
- package/{lib/locales/en-US.js → src/locales/en-US.ts} +21 -37
- package/{lib/locales/es-ES.js → src/locales/es-ES.ts} +63 -16
- package/{lib/locales/fr-FR.js → src/locales/fr-FR.ts} +74 -27
- package/src/locales/index.ts +103 -0
- package/{lib/locales/ja-JP.js → src/locales/ja-JP.ts} +59 -17
- package/src/locales/types.ts +156 -0
- package/{lib/locales/zh-CN.js → src/locales/zh-CN.ts} +21 -38
- package/src/parser/ConstraintParser.ts +101 -0
- package/src/parser/DslParser.ts +470 -0
- package/src/parser/SchemaCompiler.ts +66 -0
- package/src/parser/TypeRegistry.ts +250 -0
- package/src/parser/index.ts +6 -0
- package/src/plugins/custom-format.ts +126 -0
- package/src/plugins/custom-type-example.ts +108 -0
- package/src/plugins/custom-validator.ts +140 -0
- package/src/types/conditional.ts +28 -0
- package/src/types/config.ts +59 -0
- package/src/types/dsl.ts +131 -0
- package/src/types/error.ts +60 -0
- package/src/types/index.ts +17 -0
- package/src/types/infer.ts +128 -0
- package/src/types/plugin.ts +58 -0
- package/src/types/safe-regex.d.ts +9 -0
- package/src/types/schema.ts +66 -0
- package/src/types/validate.ts +71 -0
- package/src/utils/SchemaHelper.ts +196 -0
- package/src/utils/SchemaUtils.ts +346 -0
- package/src/utils/TypeConverter.ts +215 -0
- package/src/utils/index.ts +10 -0
- package/src/validators/CustomKeywords.ts +477 -0
- package/.eslintignore +0 -11
- package/.eslintrc.json +0 -27
- package/CONTRIBUTING.md +0 -368
- package/STATUS.md +0 -491
- package/changelogs/v1.0.0.md +0 -328
- package/changelogs/v1.0.9.md +0 -367
- package/changelogs/v1.1.0.md +0 -389
- package/changelogs/v1.1.1.md +0 -308
- package/changelogs/v1.1.2.md +0 -183
- package/changelogs/v1.1.3.md +0 -161
- package/changelogs/v1.1.4.md +0 -432
- package/changelogs/v1.1.5.md +0 -493
- package/changelogs/v1.1.6.md +0 -211
- package/changelogs/v1.1.8.md +0 -376
- package/changelogs/v1.2.3.md +0 -124
- package/docs/INDEX.md +0 -252
- package/docs/issues-resolved-summary.md +0 -196
- package/docs/performance-benchmark-report.md +0 -179
- package/docs/performance-quick-reference.md +0 -123
- package/docs/user-questions-answered.md +0 -353
- package/docs/validation-rules-v1.0.2.md +0 -1608
- package/examples/README.md +0 -81
- package/examples/array-dsl-example.js +0 -227
- package/examples/conditional-example.js +0 -288
- package/examples/conditional-non-object.js +0 -129
- package/examples/conditional-validate-example.js +0 -321
- package/examples/custom-extension.js +0 -85
- package/examples/dsl-match-example.js +0 -74
- package/examples/dsl-style.js +0 -118
- package/examples/dynamic-locale-configuration.js +0 -348
- package/examples/dynamic-locale-example.js +0 -287
- package/examples/enum.examples.js +0 -324
- package/examples/export-demo.js +0 -130
- package/examples/express-integration.js +0 -376
- package/examples/i18n-error-handling-complete.js +0 -381
- package/examples/i18n-error-handling-quickstart.md +0 -0
- package/examples/i18n-error.examples.js +0 -181
- package/examples/i18n-full-demo.js +0 -301
- package/examples/i18n-memory-safety.examples.js +0 -268
- package/examples/markdown-export.js +0 -71
- package/examples/middleware-usage.js +0 -93
- package/examples/new-features-comparison.js +0 -315
- package/examples/password-reset/README.md +0 -153
- package/examples/password-reset/schema.js +0 -26
- package/examples/password-reset/test.js +0 -101
- package/examples/plugin-system.examples.js +0 -205
- package/examples/schema-utils-chaining.examples.js +0 -250
- package/examples/simple-example.js +0 -122
- package/examples/slug.examples.js +0 -179
- package/examples/string-extensions.js +0 -297
- package/examples/union-type-example.js +0 -127
- package/examples/union-types-example.js +0 -77
- package/examples/user-registration/README.md +0 -156
- package/examples/user-registration/routes.js +0 -92
- package/examples/user-registration/schema.js +0 -150
- package/examples/user-registration/server.js +0 -74
- package/index.d.ts +0 -3540
- package/index.js +0 -457
- package/index.mjs +0 -60
- package/lib/adapters/DslAdapter.js +0 -871
- package/lib/adapters/index.js +0 -20
- package/lib/config/constants.js +0 -286
- package/lib/config/patterns/common.js +0 -47
- package/lib/config/patterns/creditCard.js +0 -9
- package/lib/config/patterns/idCard.js +0 -9
- package/lib/config/patterns/index.js +0 -9
- package/lib/config/patterns/licensePlate.js +0 -4
- package/lib/config/patterns/passport.js +0 -4
- package/lib/config/patterns/phone.js +0 -9
- package/lib/config/patterns/postalCode.js +0 -5
- package/lib/core/CacheManager.js +0 -376
- package/lib/core/ConditionalBuilder.js +0 -503
- package/lib/core/DslBuilder.js +0 -1400
- package/lib/core/ErrorCodes.js +0 -233
- package/lib/core/ErrorFormatter.js +0 -445
- package/lib/core/JSONSchemaCore.js +0 -347
- package/lib/core/Locale.js +0 -130
- package/lib/core/MessageTemplate.js +0 -98
- package/lib/core/PluginManager.js +0 -448
- package/lib/core/StringExtensions.js +0 -240
- package/lib/core/Validator.js +0 -654
- package/lib/errors/I18nError.js +0 -328
- package/lib/errors/ValidationError.js +0 -191
- package/lib/exporters/MarkdownExporter.js +0 -420
- package/lib/exporters/MongoDBExporter.js +0 -162
- package/lib/exporters/MySQLExporter.js +0 -212
- package/lib/exporters/PostgreSQLExporter.js +0 -289
- package/lib/exporters/index.js +0 -24
- package/lib/locales/index.js +0 -8
- package/lib/utils/LRUCache.js +0 -174
- package/lib/utils/SchemaHelper.js +0 -240
- package/lib/utils/SchemaUtils.js +0 -445
- package/lib/utils/TypeConverter.js +0 -245
- package/lib/utils/index.js +0 -13
- package/lib/validators/CustomKeywords.js +0 -616
- package/lib/validators/index.js +0 -11
|
@@ -1,287 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* 动态多语言配置示例
|
|
3
|
-
*
|
|
4
|
-
* 演示如何从请求头动态获取语言并进行验证
|
|
5
|
-
*/
|
|
6
|
-
|
|
7
|
-
const { dsl, Validator, Locale } = require('../index');
|
|
8
|
-
|
|
9
|
-
// ========== 1. 初始化语言包 ==========
|
|
10
|
-
|
|
11
|
-
console.log('📦 初始化语言包...\n');
|
|
12
|
-
|
|
13
|
-
// 中文语言包
|
|
14
|
-
Locale.addLocale('zh-CN', {
|
|
15
|
-
'required': '{{#label}}不能为空',
|
|
16
|
-
'min': '{{#label}}至少{{#limit}}个字符',
|
|
17
|
-
'max': '{{#label}}最多{{#limit}}个字符',
|
|
18
|
-
'pattern': '{{#label}}格式不正确',
|
|
19
|
-
'format': '请输入有效的{{#label}}',
|
|
20
|
-
|
|
21
|
-
// Labels
|
|
22
|
-
'label.username': '用户名',
|
|
23
|
-
'label.email': '邮箱地址',
|
|
24
|
-
'label.password': '密码',
|
|
25
|
-
'label.age': '年龄'
|
|
26
|
-
});
|
|
27
|
-
|
|
28
|
-
// 英文语言包
|
|
29
|
-
Locale.addLocale('en-US', {
|
|
30
|
-
'required': '{{#label}} is required',
|
|
31
|
-
'min': '{{#label}} must be at least {{#limit}} characters',
|
|
32
|
-
'max': '{{#label}} must be at most {{#limit}} characters',
|
|
33
|
-
'pattern': '{{#label}} format is invalid',
|
|
34
|
-
'format': 'Please enter a valid {{#label}}',
|
|
35
|
-
|
|
36
|
-
// Labels
|
|
37
|
-
'label.username': 'Username',
|
|
38
|
-
'label.email': 'Email',
|
|
39
|
-
'label.password': 'Password',
|
|
40
|
-
'label.age': 'Age'
|
|
41
|
-
});
|
|
42
|
-
|
|
43
|
-
console.log('✅ 语言包已加载: zh-CN, en-US\n');
|
|
44
|
-
|
|
45
|
-
// ========== 2. 定义Schema ==========
|
|
46
|
-
|
|
47
|
-
console.log('📋 定义Schema...\n');
|
|
48
|
-
|
|
49
|
-
const userSchema = dsl({
|
|
50
|
-
username: 'string:3-32!'.label('label.username'),
|
|
51
|
-
email: 'email!'.label('label.email'),
|
|
52
|
-
password: 'string:8-64!'
|
|
53
|
-
.pattern(/^(?=.*[a-z])(?=.*[A-Z])(?=.*\d).+$/)
|
|
54
|
-
.label('label.password'),
|
|
55
|
-
age: 'number:18-120'.label('label.age')
|
|
56
|
-
});
|
|
57
|
-
|
|
58
|
-
console.log('✅ Schema定义完成\n');
|
|
59
|
-
|
|
60
|
-
// ========== 3. 测试数据 ==========
|
|
61
|
-
|
|
62
|
-
const testData = {
|
|
63
|
-
username: 'ab', // 太短
|
|
64
|
-
email: 'invalid-email', // 格式错误
|
|
65
|
-
password: 'weak', // 不符合强度要求
|
|
66
|
-
age: 15 // 年龄不够
|
|
67
|
-
};
|
|
68
|
-
|
|
69
|
-
// ========== 4. 创建验证器 ==========
|
|
70
|
-
|
|
71
|
-
const validator = new Validator();
|
|
72
|
-
|
|
73
|
-
// ========== 5. 测试不同语言 ==========
|
|
74
|
-
|
|
75
|
-
console.log('🧪 测试验证 - 不同语言\n');
|
|
76
|
-
console.log('=' .repeat(60));
|
|
77
|
-
|
|
78
|
-
// 中文验证
|
|
79
|
-
console.log('\n📍 测试1: 中文错误消息 (locale: zh-CN)');
|
|
80
|
-
console.log('-'.repeat(60));
|
|
81
|
-
|
|
82
|
-
const result1 = validator.validate(userSchema, testData, {
|
|
83
|
-
locale: 'zh-CN'
|
|
84
|
-
});
|
|
85
|
-
|
|
86
|
-
console.log('验证结果:', result1.valid ? '✅ 通过' : '❌ 失败');
|
|
87
|
-
if (!result1.valid) {
|
|
88
|
-
console.log('\n错误列表:');
|
|
89
|
-
result1.errors.forEach((error, index) => {
|
|
90
|
-
console.log(` ${index + 1}. ${error.path}: ${error.message}`);
|
|
91
|
-
});
|
|
92
|
-
}
|
|
93
|
-
|
|
94
|
-
// 英文验证
|
|
95
|
-
console.log('\n📍 测试2: 英文错误消息 (locale: en-US)');
|
|
96
|
-
console.log('-'.repeat(60));
|
|
97
|
-
|
|
98
|
-
const result2 = validator.validate(userSchema, testData, {
|
|
99
|
-
locale: 'en-US'
|
|
100
|
-
});
|
|
101
|
-
|
|
102
|
-
console.log('验证结果:', result2.valid ? '✅ 通过' : '❌ 失败');
|
|
103
|
-
if (!result2.valid) {
|
|
104
|
-
console.log('\n错误列表:');
|
|
105
|
-
result2.errors.forEach((error, index) => {
|
|
106
|
-
console.log(` ${index + 1}. ${error.path}: ${error.message}`);
|
|
107
|
-
});
|
|
108
|
-
}
|
|
109
|
-
|
|
110
|
-
// ========== 6. 模拟HTTP请求场景 ==========
|
|
111
|
-
|
|
112
|
-
console.log('\n\n🌐 模拟HTTP请求场景');
|
|
113
|
-
console.log('=' .repeat(60));
|
|
114
|
-
|
|
115
|
-
/**
|
|
116
|
-
* 解析 Accept-Language 头
|
|
117
|
-
*/
|
|
118
|
-
function parseAcceptLanguage(acceptLanguage) {
|
|
119
|
-
if (!acceptLanguage) return 'en-US';
|
|
120
|
-
|
|
121
|
-
const languages = acceptLanguage.split(',').map(lang => {
|
|
122
|
-
const [code, qValue] = lang.trim().split(';');
|
|
123
|
-
const q = qValue ? parseFloat(qValue.split('=')[1]) : 1.0;
|
|
124
|
-
return { code: code.trim(), q };
|
|
125
|
-
});
|
|
126
|
-
|
|
127
|
-
languages.sort((a, b) => b.q - a.q);
|
|
128
|
-
|
|
129
|
-
const supportedLocales = ['zh-CN', 'en-US'];
|
|
130
|
-
for (const lang of languages) {
|
|
131
|
-
const matched = supportedLocales.find(locale =>
|
|
132
|
-
locale.toLowerCase() === lang.code.toLowerCase()
|
|
133
|
-
);
|
|
134
|
-
if (matched) return matched;
|
|
135
|
-
}
|
|
136
|
-
|
|
137
|
-
return 'en-US';
|
|
138
|
-
}
|
|
139
|
-
|
|
140
|
-
/**
|
|
141
|
-
* 模拟验证请求
|
|
142
|
-
*/
|
|
143
|
-
function handleRequest(acceptLanguage, data) {
|
|
144
|
-
const locale = parseAcceptLanguage(acceptLanguage);
|
|
145
|
-
|
|
146
|
-
console.log(`\n📍 请求头: Accept-Language: ${acceptLanguage}`);
|
|
147
|
-
console.log(` 解析语言: ${locale}`);
|
|
148
|
-
console.log('-'.repeat(60));
|
|
149
|
-
|
|
150
|
-
const result = validator.validate(userSchema, data, { locale });
|
|
151
|
-
|
|
152
|
-
if (!result.valid) {
|
|
153
|
-
console.log('❌ 验证失败:');
|
|
154
|
-
result.errors.forEach((error, index) => {
|
|
155
|
-
console.log(` ${index + 1}. ${error.path}: ${error.message}`);
|
|
156
|
-
});
|
|
157
|
-
} else {
|
|
158
|
-
console.log('✅ 验证通过');
|
|
159
|
-
}
|
|
160
|
-
|
|
161
|
-
return result;
|
|
162
|
-
}
|
|
163
|
-
|
|
164
|
-
// 测试不同的 Accept-Language 头
|
|
165
|
-
handleRequest('zh-CN,zh;q=0.9,en;q=0.8', testData);
|
|
166
|
-
handleRequest('en-US,en;q=0.9', testData);
|
|
167
|
-
handleRequest('zh-CN', testData);
|
|
168
|
-
handleRequest('en-US', testData);
|
|
169
|
-
handleRequest('ja-JP,en-US;q=0.8', testData); // 不支持的语言,回退到英文
|
|
170
|
-
|
|
171
|
-
// ========== 6.1 格式化类型测试 (v2.1.0 新增) ==========
|
|
172
|
-
|
|
173
|
-
console.log('\n\n🌐 格式化类型测试 (v2.1.0)');
|
|
174
|
-
console.log('=' .repeat(60));
|
|
175
|
-
|
|
176
|
-
const formatSchema = dsl({
|
|
177
|
-
email: 'email!',
|
|
178
|
-
url: 'url!',
|
|
179
|
-
ipv4: 'ipv4!'
|
|
180
|
-
});
|
|
181
|
-
|
|
182
|
-
const formatData = {
|
|
183
|
-
email: 'invalid-email',
|
|
184
|
-
url: 'invalid-url',
|
|
185
|
-
ipv4: '999.999.999.999'
|
|
186
|
-
};
|
|
187
|
-
|
|
188
|
-
function testFormat(locale) {
|
|
189
|
-
console.log(`\nTesting format with locale: ${locale}`);
|
|
190
|
-
const result = validator.validate(formatSchema, formatData, { locale });
|
|
191
|
-
result.errors.forEach(e => console.log(` ${e.path}: ${e.message}`));
|
|
192
|
-
}
|
|
193
|
-
|
|
194
|
-
testFormat('zh-CN');
|
|
195
|
-
testFormat('en-US');
|
|
196
|
-
testFormat('ja-JP'); // 如果已加载 ja-JP
|
|
197
|
-
|
|
198
|
-
// ========== 7. 并发测试 ==========
|
|
199
|
-
|
|
200
|
-
console.log('\n\n⚡ 并发测试 - 验证无竞态问题');
|
|
201
|
-
console.log('=' .repeat(60));
|
|
202
|
-
|
|
203
|
-
async function concurrentTest() {
|
|
204
|
-
const promises = [
|
|
205
|
-
// 5个中文请求
|
|
206
|
-
...Array(5).fill().map(() =>
|
|
207
|
-
Promise.resolve(validator.validate(userSchema, testData, { locale: 'zh-CN' }))
|
|
208
|
-
),
|
|
209
|
-
// 5个英文请求
|
|
210
|
-
...Array(5).fill().map(() =>
|
|
211
|
-
Promise.resolve(validator.validate(userSchema, testData, { locale: 'en-US' }))
|
|
212
|
-
)
|
|
213
|
-
];
|
|
214
|
-
|
|
215
|
-
const results = await Promise.all(promises);
|
|
216
|
-
|
|
217
|
-
// 检查结果
|
|
218
|
-
const zhResults = results.slice(0, 5);
|
|
219
|
-
const enResults = results.slice(5);
|
|
220
|
-
|
|
221
|
-
const allZhCorrect = zhResults.every(r =>
|
|
222
|
-
r.errors[0].message.includes('用户名')
|
|
223
|
-
);
|
|
224
|
-
|
|
225
|
-
const allEnCorrect = enResults.every(r =>
|
|
226
|
-
r.errors[0].message.includes('username')
|
|
227
|
-
);
|
|
228
|
-
|
|
229
|
-
console.log('\n并发测试结果:');
|
|
230
|
-
console.log(` 中文请求 (5个): ${allZhCorrect ? '✅ 全部正确' : '❌ 有错误'}`);
|
|
231
|
-
console.log(` 英文请求 (5个): ${allEnCorrect ? '✅ 全部正确' : '❌ 有错误'}`);
|
|
232
|
-
|
|
233
|
-
if (allZhCorrect && allEnCorrect) {
|
|
234
|
-
console.log('\n🎉 并发测试通过!无竞态问题!');
|
|
235
|
-
}
|
|
236
|
-
}
|
|
237
|
-
|
|
238
|
-
concurrentTest();
|
|
239
|
-
|
|
240
|
-
// ========== 8. 正确数据测试 ==========
|
|
241
|
-
|
|
242
|
-
console.log('\n\n✅ 测试正确数据');
|
|
243
|
-
console.log('=' .repeat(60));
|
|
244
|
-
|
|
245
|
-
const validData = {
|
|
246
|
-
username: 'john_doe',
|
|
247
|
-
email: 'john@example.com',
|
|
248
|
-
password: 'Password123',
|
|
249
|
-
age: 25
|
|
250
|
-
};
|
|
251
|
-
|
|
252
|
-
console.log('\n📍 中文验证');
|
|
253
|
-
const validResult1 = validator.validate(userSchema, validData, {
|
|
254
|
-
locale: 'zh-CN'
|
|
255
|
-
});
|
|
256
|
-
console.log('结果:', validResult1.valid ? '✅ 验证通过' : '❌ 验证失败');
|
|
257
|
-
|
|
258
|
-
console.log('\n📍 英文验证');
|
|
259
|
-
const validResult2 = validator.validate(userSchema, validData, {
|
|
260
|
-
locale: 'en-US'
|
|
261
|
-
});
|
|
262
|
-
console.log('结果:', validResult2.valid ? '✅ 验证通过' : '❌ 验证失败');
|
|
263
|
-
|
|
264
|
-
// ========== 总结 ==========
|
|
265
|
-
|
|
266
|
-
console.log('\n\n' + '='.repeat(60));
|
|
267
|
-
console.log('📊 总结');
|
|
268
|
-
console.log('='.repeat(60));
|
|
269
|
-
console.log(`
|
|
270
|
-
✅ 核心功能:
|
|
271
|
-
1. 支持动态语言切换 (locale参数)
|
|
272
|
-
2. 支持并发请求,无竞态问题
|
|
273
|
-
3. 自动解析 Accept-Language 头
|
|
274
|
-
4. 支持多语言错误消息
|
|
275
|
-
|
|
276
|
-
✅ 使用方式:
|
|
277
|
-
validator.validate(schema, data, { locale: 'zh-CN' })
|
|
278
|
-
|
|
279
|
-
✅ 推荐场景:
|
|
280
|
-
- Express/Koa API 服务
|
|
281
|
-
- 多语言Web应用
|
|
282
|
-
- 国际化移动应用后端
|
|
283
|
-
|
|
284
|
-
📖 详细文档: docs/dynamic-locale.md
|
|
285
|
-
`);
|
|
286
|
-
|
|
287
|
-
|
|
@@ -1,324 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* 枚举功能完整示例
|
|
3
|
-
*
|
|
4
|
-
* 演示 schema-dsl 中枚举的各种用法
|
|
5
|
-
*
|
|
6
|
-
* @since v1.1.0
|
|
7
|
-
*/
|
|
8
|
-
|
|
9
|
-
const { dsl, validate } = require('../index');
|
|
10
|
-
|
|
11
|
-
console.log('========== 枚举功能示例 ==========\n');
|
|
12
|
-
|
|
13
|
-
// ========================================
|
|
14
|
-
// 1. 基础字符串枚举
|
|
15
|
-
// ========================================
|
|
16
|
-
console.log('【示例 1】基础字符串枚举\n');
|
|
17
|
-
|
|
18
|
-
const userSchema = dsl({
|
|
19
|
-
username: 'string:3-32!',
|
|
20
|
-
role: 'admin|user|guest!', // 简写形式
|
|
21
|
-
status: 'enum:active|inactive|pending' // 完整形式
|
|
22
|
-
});
|
|
23
|
-
|
|
24
|
-
let result = validate(userSchema, {
|
|
25
|
-
username: 'john_doe',
|
|
26
|
-
role: 'admin',
|
|
27
|
-
status: 'active'
|
|
28
|
-
});
|
|
29
|
-
|
|
30
|
-
console.log('✅ 验证通过:', result.valid);
|
|
31
|
-
console.log('数据:', result.data);
|
|
32
|
-
console.log('');
|
|
33
|
-
|
|
34
|
-
// 测试无效值
|
|
35
|
-
result = validate(userSchema, {
|
|
36
|
-
username: 'jane',
|
|
37
|
-
role: 'superadmin', // 无效值
|
|
38
|
-
status: 'active'
|
|
39
|
-
});
|
|
40
|
-
|
|
41
|
-
console.log('❌ 验证失败:', !result.valid);
|
|
42
|
-
console.log('错误:', result.errors[0].message);
|
|
43
|
-
console.log('');
|
|
44
|
-
|
|
45
|
-
// ========================================
|
|
46
|
-
// 2. 布尔值枚举
|
|
47
|
-
// ========================================
|
|
48
|
-
console.log('【示例 2】布尔值枚举\n');
|
|
49
|
-
|
|
50
|
-
const featureSchema = dsl({
|
|
51
|
-
name: 'string!',
|
|
52
|
-
isEnabled: 'true|false!', // 自动识别为布尔值
|
|
53
|
-
isPublic: 'enum:boolean:true|false', // 显式指定布尔值
|
|
54
|
-
verified: 'true|false' // 可选的布尔值
|
|
55
|
-
});
|
|
56
|
-
|
|
57
|
-
result = validate(featureSchema, {
|
|
58
|
-
name: 'dark-mode',
|
|
59
|
-
isEnabled: true,
|
|
60
|
-
isPublic: false
|
|
61
|
-
});
|
|
62
|
-
|
|
63
|
-
console.log('✅ 验证通过:', result.valid);
|
|
64
|
-
console.log('数据:', result.data);
|
|
65
|
-
console.log('');
|
|
66
|
-
|
|
67
|
-
// 测试类型错误
|
|
68
|
-
result = validate(featureSchema, {
|
|
69
|
-
name: 'feature-x',
|
|
70
|
-
isEnabled: 'true', // 字符串 'true' 不是布尔值
|
|
71
|
-
isPublic: false
|
|
72
|
-
});
|
|
73
|
-
|
|
74
|
-
console.log('❌ 类型错误(字符串 vs 布尔值):', !result.valid);
|
|
75
|
-
console.log('');
|
|
76
|
-
|
|
77
|
-
// ========================================
|
|
78
|
-
// 3. 数字枚举
|
|
79
|
-
// ========================================
|
|
80
|
-
console.log('【示例 3】数字枚举\n');
|
|
81
|
-
|
|
82
|
-
const taskSchema = dsl({
|
|
83
|
-
title: 'string!',
|
|
84
|
-
priority: '1|2|3!', // 自动识别为数字
|
|
85
|
-
level: 'enum:number:1|2|3|4|5', // 显式指定数字
|
|
86
|
-
rating: '1.0|1.5|2.0|2.5|3.0' // 小数枚举
|
|
87
|
-
});
|
|
88
|
-
|
|
89
|
-
result = validate(taskSchema, {
|
|
90
|
-
title: 'Fix bug',
|
|
91
|
-
priority: 1,
|
|
92
|
-
level: 3,
|
|
93
|
-
rating: 2.5
|
|
94
|
-
});
|
|
95
|
-
|
|
96
|
-
console.log('✅ 验证通过:', result.valid);
|
|
97
|
-
console.log('数据:', result.data);
|
|
98
|
-
console.log('');
|
|
99
|
-
|
|
100
|
-
// 测试超出范围
|
|
101
|
-
result = validate(taskSchema, {
|
|
102
|
-
title: 'New task',
|
|
103
|
-
priority: 4, // 超出 1|2|3
|
|
104
|
-
level: 2
|
|
105
|
-
});
|
|
106
|
-
|
|
107
|
-
console.log('❌ 超出范围:', !result.valid);
|
|
108
|
-
console.log('');
|
|
109
|
-
|
|
110
|
-
// ========================================
|
|
111
|
-
// 4. 整数枚举
|
|
112
|
-
// ========================================
|
|
113
|
-
console.log('【示例 4】整数枚举(禁止小数)\n');
|
|
114
|
-
|
|
115
|
-
const gameSchema = dsl({
|
|
116
|
-
playerName: 'string!',
|
|
117
|
-
difficulty: 'enum:integer:1|2|3' // 必须是整数
|
|
118
|
-
});
|
|
119
|
-
|
|
120
|
-
result = validate(gameSchema, {
|
|
121
|
-
playerName: 'Alice',
|
|
122
|
-
difficulty: 2
|
|
123
|
-
});
|
|
124
|
-
|
|
125
|
-
console.log('✅ 整数验证通过:', result.valid);
|
|
126
|
-
console.log('');
|
|
127
|
-
|
|
128
|
-
// 小数应该失败
|
|
129
|
-
result = validate(gameSchema, {
|
|
130
|
-
playerName: 'Bob',
|
|
131
|
-
difficulty: 1.5 // 小数不符合 integer 类型
|
|
132
|
-
});
|
|
133
|
-
|
|
134
|
-
console.log('❌ 小数验证失败:', !result.valid);
|
|
135
|
-
console.log('');
|
|
136
|
-
|
|
137
|
-
// ========================================
|
|
138
|
-
// 5. 枚举与链式 API
|
|
139
|
-
// ========================================
|
|
140
|
-
console.log('【示例 5】枚举与链式 API\n');
|
|
141
|
-
|
|
142
|
-
const postSchema = dsl({
|
|
143
|
-
title: 'string:5-100!',
|
|
144
|
-
status: dsl('draft|published|archived')
|
|
145
|
-
.label('文章状态')
|
|
146
|
-
.messages({
|
|
147
|
-
'enum': '状态必须是: 草稿、已发布或已归档'
|
|
148
|
-
}),
|
|
149
|
-
visibility: dsl('public|private|unlisted!')
|
|
150
|
-
.label('可见性')
|
|
151
|
-
.default('public')
|
|
152
|
-
});
|
|
153
|
-
|
|
154
|
-
result = validate(postSchema, {
|
|
155
|
-
title: 'My First Post',
|
|
156
|
-
status: 'invalid_status',
|
|
157
|
-
visibility: 'public'
|
|
158
|
-
});
|
|
159
|
-
|
|
160
|
-
console.log('❌ 自定义错误消息:', !result.valid);
|
|
161
|
-
console.log('错误:', result.errors[0].message);
|
|
162
|
-
console.log('');
|
|
163
|
-
|
|
164
|
-
// ========================================
|
|
165
|
-
// 6. 数组中的枚举
|
|
166
|
-
// ========================================
|
|
167
|
-
console.log('【示例 6】数组中的枚举\n');
|
|
168
|
-
|
|
169
|
-
const articleSchema = dsl({
|
|
170
|
-
title: 'string!',
|
|
171
|
-
tags: 'array<enum:tech|business|lifestyle>',
|
|
172
|
-
permissions: 'array<enum:read|write|delete>'
|
|
173
|
-
});
|
|
174
|
-
|
|
175
|
-
result = validate(articleSchema, {
|
|
176
|
-
title: 'Tech Article',
|
|
177
|
-
tags: ['tech', 'business'],
|
|
178
|
-
permissions: ['read', 'write']
|
|
179
|
-
});
|
|
180
|
-
|
|
181
|
-
console.log('✅ 数组枚举验证通过:', result.valid);
|
|
182
|
-
console.log('数据:', result.data);
|
|
183
|
-
console.log('');
|
|
184
|
-
|
|
185
|
-
// ========================================
|
|
186
|
-
// 7. 复杂对象中的枚举
|
|
187
|
-
// ========================================
|
|
188
|
-
console.log('【示例 7】复杂对象中的枚举\n');
|
|
189
|
-
|
|
190
|
-
const orderSchema = dsl({
|
|
191
|
-
orderId: 'string!',
|
|
192
|
-
status: 'pending|processing|completed|cancelled!',
|
|
193
|
-
priority: '1|2|3'.default(2),
|
|
194
|
-
payment: {
|
|
195
|
-
method: 'card|paypal|crypto!',
|
|
196
|
-
status: 'pending|success|failed!'
|
|
197
|
-
},
|
|
198
|
-
items: 'array',
|
|
199
|
-
metadata: {
|
|
200
|
-
isUrgent: 'true|false',
|
|
201
|
-
category: 'electronics|clothing|food'
|
|
202
|
-
}
|
|
203
|
-
});
|
|
204
|
-
|
|
205
|
-
result = validate(orderSchema, {
|
|
206
|
-
orderId: 'ORD-12345',
|
|
207
|
-
status: 'processing',
|
|
208
|
-
priority: 1,
|
|
209
|
-
payment: {
|
|
210
|
-
method: 'card',
|
|
211
|
-
status: 'success'
|
|
212
|
-
},
|
|
213
|
-
items: [],
|
|
214
|
-
metadata: {
|
|
215
|
-
isUrgent: true,
|
|
216
|
-
category: 'electronics'
|
|
217
|
-
}
|
|
218
|
-
});
|
|
219
|
-
|
|
220
|
-
console.log('✅ 复杂对象验证通过:', result.valid);
|
|
221
|
-
console.log('数据:', JSON.stringify(result.data, null, 2));
|
|
222
|
-
console.log('');
|
|
223
|
-
|
|
224
|
-
// ========================================
|
|
225
|
-
// 8. 错误处理
|
|
226
|
-
// ========================================
|
|
227
|
-
console.log('【示例 8】错误处理\n');
|
|
228
|
-
|
|
229
|
-
try {
|
|
230
|
-
// 无效的布尔值枚举
|
|
231
|
-
dsl({ flag: 'enum:boolean:true|false|maybe' });
|
|
232
|
-
} catch (error) {
|
|
233
|
-
console.log('❌ 捕获错误:', error.message);
|
|
234
|
-
}
|
|
235
|
-
|
|
236
|
-
try {
|
|
237
|
-
// 无效的数字枚举
|
|
238
|
-
dsl({ value: 'enum:number:1|2|abc' });
|
|
239
|
-
} catch (error) {
|
|
240
|
-
console.log('❌ 捕获错误:', error.message);
|
|
241
|
-
}
|
|
242
|
-
|
|
243
|
-
console.log('');
|
|
244
|
-
|
|
245
|
-
// ========================================
|
|
246
|
-
// 9. 实际应用场景
|
|
247
|
-
// ========================================
|
|
248
|
-
console.log('【示例 9】实际应用 - 用户管理系统\n');
|
|
249
|
-
|
|
250
|
-
const userManagementSchema = dsl({
|
|
251
|
-
// 基本信息
|
|
252
|
-
userId: 'string!',
|
|
253
|
-
username: 'string:3-32!',
|
|
254
|
-
email: 'email!',
|
|
255
|
-
|
|
256
|
-
// 枚举字段
|
|
257
|
-
role: 'admin|moderator|user|guest!',
|
|
258
|
-
status: 'active|inactive|suspended|banned',
|
|
259
|
-
emailVerified: 'true|false',
|
|
260
|
-
|
|
261
|
-
// 权限等级(数字枚举)
|
|
262
|
-
permissionLevel: '0|1|2|3|4|5'.default(0),
|
|
263
|
-
|
|
264
|
-
// 偏好设置
|
|
265
|
-
preferences: {
|
|
266
|
-
theme: 'light|dark|auto',
|
|
267
|
-
language: 'en|zh-CN|zh-TW|ja|ko',
|
|
268
|
-
notifications: 'all|mentions|none'
|
|
269
|
-
}
|
|
270
|
-
});
|
|
271
|
-
|
|
272
|
-
const newUser = {
|
|
273
|
-
userId: 'u_12345',
|
|
274
|
-
username: 'alice',
|
|
275
|
-
email: 'alice@example.com',
|
|
276
|
-
role: 'user',
|
|
277
|
-
status: 'active',
|
|
278
|
-
emailVerified: true,
|
|
279
|
-
permissionLevel: 1,
|
|
280
|
-
preferences: {
|
|
281
|
-
theme: 'dark',
|
|
282
|
-
language: 'zh-CN',
|
|
283
|
-
notifications: 'mentions'
|
|
284
|
-
}
|
|
285
|
-
};
|
|
286
|
-
|
|
287
|
-
result = validate(userManagementSchema, newUser);
|
|
288
|
-
|
|
289
|
-
console.log('✅ 用户数据验证通过:', result.valid);
|
|
290
|
-
console.log('用户数据:', JSON.stringify(result.data, null, 2));
|
|
291
|
-
console.log('');
|
|
292
|
-
|
|
293
|
-
// ========================================
|
|
294
|
-
// 10. 性能测试
|
|
295
|
-
// ========================================
|
|
296
|
-
console.log('【示例 10】性能测试\n');
|
|
297
|
-
|
|
298
|
-
const perfSchema = dsl({
|
|
299
|
-
status: 'active|inactive|pending',
|
|
300
|
-
priority: '1|2|3',
|
|
301
|
-
flag: 'true|false'
|
|
302
|
-
});
|
|
303
|
-
|
|
304
|
-
const iterations = 10000;
|
|
305
|
-
const startTime = Date.now();
|
|
306
|
-
|
|
307
|
-
for (let i = 0; i < iterations; i++) {
|
|
308
|
-
validate(perfSchema, {
|
|
309
|
-
status: 'active',
|
|
310
|
-
priority: 2,
|
|
311
|
-
flag: true
|
|
312
|
-
});
|
|
313
|
-
}
|
|
314
|
-
|
|
315
|
-
const endTime = Date.now();
|
|
316
|
-
const duration = endTime - startTime;
|
|
317
|
-
const perSecond = Math.round((iterations / duration) * 1000);
|
|
318
|
-
|
|
319
|
-
console.log(`验证 ${iterations} 次耗时: ${duration}ms`);
|
|
320
|
-
console.log(`平均每秒验证: ${perSecond.toLocaleString()} 次`);
|
|
321
|
-
console.log('');
|
|
322
|
-
|
|
323
|
-
console.log('========== 示例结束 ==========');
|
|
324
|
-
|