schema-dsl 2.0.0 → 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.
- package/CHANGELOG.md +130 -113
- package/LICENSE +21 -21
- package/README.md +628 -628
- package/dist/{DslBuilder-DkLaOo9Q.d.ts → DslBuilder-BIgQOAXp.d.ts} +2 -0
- package/dist/{DslBuilder-DQDN0ZxZ.d.cts → DslBuilder-CjHTucNQ.d.cts} +2 -0
- package/dist/{Validator-hFWKGxir.d.ts → Validator-CllRdrY0.d.ts} +1 -1
- package/dist/{Validator-C7GsVQOH.d.cts → Validator-D6okG9tr.d.cts} +1 -1
- package/dist/index.cjs +75 -29
- package/dist/index.d.cts +10 -4
- package/dist/index.d.ts +10 -4
- package/dist/index.js +75 -29
- package/dist/plugins/custom-format.cjs +33 -17
- package/dist/plugins/custom-format.d.cts +1 -1
- package/dist/plugins/custom-format.d.ts +1 -1
- package/dist/plugins/custom-format.js +33 -17
- package/dist/plugins/custom-type-example.cjs +33 -17
- package/dist/plugins/custom-type-example.d.cts +1 -1
- package/dist/plugins/custom-type-example.d.ts +1 -1
- package/dist/plugins/custom-type-example.js +33 -17
- package/dist/plugins/custom-validator.cjs +0 -2
- package/dist/plugins/custom-validator.d.cts +1 -1
- package/dist/plugins/custom-validator.d.ts +1 -1
- package/dist/plugins/custom-validator.js +0 -2
- package/docs/FEATURE-INDEX.md +553 -553
- package/docs/add-custom-locale.md +496 -496
- package/docs/add-keyword.md +24 -24
- package/docs/api-reference.md +1047 -1047
- package/docs/api.md +13 -13
- package/docs/best-practices-project-structure.md +417 -417
- package/docs/best-practices.md +712 -712
- package/docs/cache-manager.md +344 -344
- package/docs/compile.md +45 -45
- package/docs/conditional-api.md +1307 -1307
- package/docs/custom-extensions-guide.md +339 -339
- package/docs/design-philosophy.md +606 -606
- package/docs/doc-index.md +324 -324
- package/docs/dsl-syntax.md +714 -714
- package/docs/dynamic-locale.md +608 -608
- package/docs/enum.md +482 -482
- package/docs/error-handling.md +1975 -1975
- package/docs/export-guide.md +501 -501
- package/docs/export-limitations.md +567 -567
- package/docs/faq.md +596 -596
- package/docs/frontend-i18n-guide.md +307 -307
- package/docs/i18n-user-guide.md +487 -487
- package/docs/i18n.md +476 -476
- package/docs/index.md +48 -48
- package/docs/json-schema-basics.md +40 -40
- package/docs/label-vs-description.md +271 -271
- package/docs/markdown-exporter.md +406 -406
- package/docs/mongodb-exporter.md +302 -302
- package/docs/multi-language.md +26 -26
- package/docs/multi-type-support.md +322 -322
- package/docs/mysql-exporter.md +280 -280
- package/docs/number-operators.md +449 -449
- package/docs/optional-marker-guide.md +326 -326
- package/docs/performance-guide.md +49 -49
- package/docs/plugin-system.md +381 -381
- package/docs/plugin-type-registration.md +34 -34
- package/docs/postgresql-exporter.md +311 -311
- package/docs/public/favicon.svg +4 -4
- package/docs/quick-start.md +435 -435
- package/docs/runtime-locale-support.md +532 -532
- package/docs/schema-helper.md +345 -345
- package/docs/schema-utils-advanced-issues.md +23 -23
- package/docs/schema-utils-best-practices.md +20 -20
- package/docs/schema-utils-chaining.md +150 -150
- package/docs/schema-utils.md +524 -524
- package/docs/security-checklist.md +20 -20
- package/docs/string-extensions.md +488 -488
- package/docs/troubleshooting.md +486 -486
- package/docs/type-converter.md +310 -310
- package/docs/type-reference.md +242 -242
- package/docs/typescript-guide.md +584 -584
- package/docs/union-type-guide.md +157 -157
- package/docs/union-types.md +284 -284
- package/docs/validate-async.md +491 -491
- package/docs/validate-batch.md +49 -49
- package/docs/validate-dsl-object-support.md +578 -578
- package/docs/validate.md +506 -506
- package/docs/validation-guide.md +502 -502
- package/docs/validator.md +39 -39
- package/package.json +131 -131
- package/plugins/custom-format.cjs +8 -8
- package/plugins/custom-type-example.cjs +8 -8
- package/plugins/custom-validator.cjs +8 -8
- package/src/adapters/DslAdapter.ts +111 -111
- package/src/adapters/index.ts +1 -1
- package/src/config/constants.ts +83 -83
- package/src/config/index.ts +2 -2
- package/src/config/patterns.ts +77 -77
- package/src/core/CacheManager.ts +169 -159
- package/src/core/ConditionalBuilder.ts +382 -382
- package/src/core/ConditionalRuntime.ts +27 -27
- package/src/core/ConditionalValidator.ts +254 -254
- package/src/core/DslBuilder.ts +687 -677
- package/src/core/ErrorCodes.ts +38 -38
- package/src/core/ErrorFormatter.ts +271 -271
- package/src/core/JSONSchemaCore.ts +65 -65
- package/src/core/Locale.ts +187 -187
- package/src/core/MessageTemplate.ts +42 -42
- package/src/core/ObjectDslBuilder.ts +64 -64
- package/src/core/PluginManager.ts +326 -326
- package/src/core/StringExtensions.ts +140 -140
- package/src/core/TemplateEngine.ts +44 -44
- package/src/core/Validator.ts +448 -448
- package/src/errors/I18nError.ts +159 -159
- package/src/errors/ValidationError.ts +105 -105
- package/src/exporters/BaseExporter.ts +60 -60
- package/src/exporters/MarkdownExporter.ts +305 -305
- package/src/exporters/MongoDBExporter.ts +126 -126
- package/src/exporters/MySQLExporter.ts +156 -155
- package/src/exporters/PostgreSQLExporter.ts +222 -222
- package/src/exporters/index.ts +18 -18
- package/src/index.ts +651 -633
- package/src/locales/en-US.ts +160 -160
- package/src/locales/es-ES.ts +160 -160
- package/src/locales/fr-FR.ts +160 -160
- package/src/locales/index.ts +103 -103
- package/src/locales/ja-JP.ts +160 -160
- package/src/locales/types.ts +156 -156
- package/src/locales/zh-CN.ts +160 -160
- package/src/parser/ConstraintParser.ts +101 -101
- package/src/parser/DslParser.ts +470 -470
- package/src/parser/SchemaCompiler.ts +66 -66
- package/src/parser/TypeRegistry.ts +250 -250
- package/src/parser/index.ts +6 -6
- package/src/plugins/custom-format.ts +124 -126
- package/src/plugins/custom-type-example.ts +106 -108
- package/src/plugins/custom-validator.ts +138 -140
- package/src/types/conditional.ts +28 -28
- package/src/types/config.ts +59 -59
- package/src/types/dsl.ts +131 -131
- package/src/types/error.ts +60 -60
- package/src/types/index.ts +17 -17
- package/src/types/infer.ts +127 -127
- package/src/types/plugin.ts +58 -58
- package/src/types/safe-regex.d.ts +9 -9
- package/src/types/schema.ts +66 -66
- package/src/types/validate.ts +71 -71
- package/src/utils/SchemaHelper.ts +196 -196
- package/src/utils/SchemaUtils.ts +365 -346
- package/src/utils/TypeConverter.ts +215 -215
- package/src/utils/index.ts +10 -10
- package/src/validators/CustomKeywords.ts +477 -477
package/docs/index.md
CHANGED
|
@@ -1,48 +1,48 @@
|
|
|
1
|
-
---
|
|
2
|
-
pageType: home
|
|
3
|
-
|
|
4
|
-
hero:
|
|
5
|
-
name: schema-dsl
|
|
6
|
-
text: 简洁强大的 JSON Schema 验证库
|
|
7
|
-
tagline: DSL 语法 · 链式 API · 多格式导出 · 完整 TypeScript 支持
|
|
8
|
-
actions:
|
|
9
|
-
- theme: brand
|
|
10
|
-
text: 快速上手
|
|
11
|
-
link: /quick-start
|
|
12
|
-
- theme: alt
|
|
13
|
-
text: 文档索引
|
|
14
|
-
link: /doc-index
|
|
15
|
-
- theme: alt
|
|
16
|
-
text: GitHub
|
|
17
|
-
link: https://github.com/vextjs/schema-dsl
|
|
18
|
-
|
|
19
|
-
features:
|
|
20
|
-
- title: DSL 语法
|
|
21
|
-
details: 用紧凑 DSL 字符串或对象定义验证规则,覆盖常见字段、约束与组合场景。
|
|
22
|
-
- title: 高性能验证
|
|
23
|
-
details: 基于 AJV 8 封装,支持同步、异步和批量验证,并提供缓存管理能力。
|
|
24
|
-
- title: 多格式导出
|
|
25
|
-
details: 同一份 schema 可导出到 MongoDB、MySQL、PostgreSQL 和 Markdown 文档。
|
|
26
|
-
- title: 国际化
|
|
27
|
-
details: 内置多语言错误消息与动态 locale 切换,适合服务端和前端共享校验规则。
|
|
28
|
-
- title: 插件系统
|
|
29
|
-
details: 支持扩展关键字、格式和类型注册,兼容 v1 常见插件用法。
|
|
30
|
-
- title: TypeScript 友好
|
|
31
|
-
details: 提供完整类型声明,便于在现代 Node.js 与 TypeScript 项目中直接集成。
|
|
32
|
-
---
|
|
33
|
-
|
|
34
|
-
## 入口导航
|
|
35
|
-
|
|
36
|
-
- 在线文档: https://schema-dsl.github.io
|
|
37
|
-
- 本地文档索引: [doc-index.md](./doc-index.md)
|
|
38
|
-
- 快速开始: [quick-start.md](./quick-start.md)
|
|
39
|
-
- 功能索引: [FEATURE-INDEX.md](./FEATURE-INDEX.md)
|
|
40
|
-
|
|
41
|
-
---
|
|
42
|
-
|
|
43
|
-
## 对应示例文件
|
|
44
|
-
|
|
45
|
-
**示例入口**: [home.ts](https://github.com/vextjs/schema-dsl/blob/main/examples/docs/home.ts)
|
|
46
|
-
**说明**: 覆盖首页展示的 DSL 定义、便捷验证与编译复用路径,可作为 Batch 1 的总入口样板。
|
|
47
|
-
|
|
48
|
-
|
|
1
|
+
---
|
|
2
|
+
pageType: home
|
|
3
|
+
|
|
4
|
+
hero:
|
|
5
|
+
name: schema-dsl
|
|
6
|
+
text: 简洁强大的 JSON Schema 验证库
|
|
7
|
+
tagline: DSL 语法 · 链式 API · 多格式导出 · 完整 TypeScript 支持
|
|
8
|
+
actions:
|
|
9
|
+
- theme: brand
|
|
10
|
+
text: 快速上手
|
|
11
|
+
link: /quick-start
|
|
12
|
+
- theme: alt
|
|
13
|
+
text: 文档索引
|
|
14
|
+
link: /doc-index
|
|
15
|
+
- theme: alt
|
|
16
|
+
text: GitHub
|
|
17
|
+
link: https://github.com/vextjs/schema-dsl
|
|
18
|
+
|
|
19
|
+
features:
|
|
20
|
+
- title: DSL 语法
|
|
21
|
+
details: 用紧凑 DSL 字符串或对象定义验证规则,覆盖常见字段、约束与组合场景。
|
|
22
|
+
- title: 高性能验证
|
|
23
|
+
details: 基于 AJV 8 封装,支持同步、异步和批量验证,并提供缓存管理能力。
|
|
24
|
+
- title: 多格式导出
|
|
25
|
+
details: 同一份 schema 可导出到 MongoDB、MySQL、PostgreSQL 和 Markdown 文档。
|
|
26
|
+
- title: 国际化
|
|
27
|
+
details: 内置多语言错误消息与动态 locale 切换,适合服务端和前端共享校验规则。
|
|
28
|
+
- title: 插件系统
|
|
29
|
+
details: 支持扩展关键字、格式和类型注册,兼容 v1 常见插件用法。
|
|
30
|
+
- title: TypeScript 友好
|
|
31
|
+
details: 提供完整类型声明,便于在现代 Node.js 与 TypeScript 项目中直接集成。
|
|
32
|
+
---
|
|
33
|
+
|
|
34
|
+
## 入口导航
|
|
35
|
+
|
|
36
|
+
- 在线文档: https://schema-dsl.github.io
|
|
37
|
+
- 本地文档索引: [doc-index.md](./doc-index.md)
|
|
38
|
+
- 快速开始: [quick-start.md](./quick-start.md)
|
|
39
|
+
- 功能索引: [FEATURE-INDEX.md](./FEATURE-INDEX.md)
|
|
40
|
+
|
|
41
|
+
---
|
|
42
|
+
|
|
43
|
+
## 对应示例文件
|
|
44
|
+
|
|
45
|
+
**示例入口**: [home.ts](https://github.com/vextjs/schema-dsl/blob/main/examples/docs/home.ts)
|
|
46
|
+
**说明**: 覆盖首页展示的 DSL 定义、便捷验证与编译复用路径,可作为 Batch 1 的总入口样板。
|
|
47
|
+
|
|
48
|
+
|
|
@@ -1,40 +1,40 @@
|
|
|
1
|
-
# JSON Schema 基础
|
|
2
|
-
|
|
3
|
-
schema-dsl 生成的是 JSON Schema Draft 7 风格的对象,并额外保留少量内部字段供验证器使用。
|
|
4
|
-
|
|
5
|
-
常见字段:
|
|
6
|
-
|
|
7
|
-
- `type`
|
|
8
|
-
- `properties`
|
|
9
|
-
- `required`
|
|
10
|
-
- `minLength` / `maxLength`
|
|
11
|
-
- `minimum` / `maximum`
|
|
12
|
-
- `format`
|
|
13
|
-
- `enum`
|
|
14
|
-
- `items`
|
|
15
|
-
|
|
16
|
-
对外输出纯净 JSON Schema 时,请使用 `toJsonSchema()`。
|
|
17
|
-
|
|
18
|
-
```javascript
|
|
19
|
-
const emailField = dsl('email!').label('邮箱');
|
|
20
|
-
|
|
21
|
-
emailField.toSchema();
|
|
22
|
-
// 含 _label / _customMessages 等内部字段
|
|
23
|
-
|
|
24
|
-
emailField.toJsonSchema();
|
|
25
|
-
// 纯净 JSON Schema,适合导出到外部系统
|
|
26
|
-
|
|
27
|
-
const objectSchema = dsl({
|
|
28
|
-
email: emailField,
|
|
29
|
-
age: dsl('number:18-100')
|
|
30
|
-
});
|
|
31
|
-
// dsl({ ... }) 入口直接返回 Draft 7 风格对象
|
|
32
|
-
```
|
|
33
|
-
|
|
34
|
-
---
|
|
35
|
-
|
|
36
|
-
## 对应示例文件
|
|
37
|
-
|
|
38
|
-
**示例入口**: [json-schema-basics.ts](https://github.com/vextjs/schema-dsl/blob/main/examples/docs/json-schema-basics.ts)
|
|
39
|
-
**说明**: 直接对比 `toSchema()` 与 `toJsonSchema()` 的输出差异,并展示对象入口返回的 JSON Schema 结构。
|
|
40
|
-
|
|
1
|
+
# JSON Schema 基础
|
|
2
|
+
|
|
3
|
+
schema-dsl 生成的是 JSON Schema Draft 7 风格的对象,并额外保留少量内部字段供验证器使用。
|
|
4
|
+
|
|
5
|
+
常见字段:
|
|
6
|
+
|
|
7
|
+
- `type`
|
|
8
|
+
- `properties`
|
|
9
|
+
- `required`
|
|
10
|
+
- `minLength` / `maxLength`
|
|
11
|
+
- `minimum` / `maximum`
|
|
12
|
+
- `format`
|
|
13
|
+
- `enum`
|
|
14
|
+
- `items`
|
|
15
|
+
|
|
16
|
+
对外输出纯净 JSON Schema 时,请使用 `toJsonSchema()`。
|
|
17
|
+
|
|
18
|
+
```javascript
|
|
19
|
+
const emailField = dsl('email!').label('邮箱');
|
|
20
|
+
|
|
21
|
+
emailField.toSchema();
|
|
22
|
+
// 含 _label / _customMessages 等内部字段
|
|
23
|
+
|
|
24
|
+
emailField.toJsonSchema();
|
|
25
|
+
// 纯净 JSON Schema,适合导出到外部系统
|
|
26
|
+
|
|
27
|
+
const objectSchema = dsl({
|
|
28
|
+
email: emailField,
|
|
29
|
+
age: dsl('number:18-100')
|
|
30
|
+
});
|
|
31
|
+
// dsl({ ... }) 入口直接返回 Draft 7 风格对象
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
---
|
|
35
|
+
|
|
36
|
+
## 对应示例文件
|
|
37
|
+
|
|
38
|
+
**示例入口**: [json-schema-basics.ts](https://github.com/vextjs/schema-dsl/blob/main/examples/docs/json-schema-basics.ts)
|
|
39
|
+
**说明**: 直接对比 `toSchema()` 与 `toJsonSchema()` 的输出差异,并展示对象入口返回的 JSON Schema 结构。
|
|
40
|
+
|