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.
Files changed (242) hide show
  1. package/CHANGELOG.md +87 -210
  2. package/README.md +391 -2249
  3. package/dist/DslBuilder-DQDN0ZxZ.d.cts +341 -0
  4. package/dist/DslBuilder-DkLaOo9Q.d.ts +341 -0
  5. package/dist/Validator-C7GsVQOH.d.cts +192 -0
  6. package/dist/Validator-hFWKGxir.d.ts +192 -0
  7. package/dist/index.cjs +6594 -0
  8. package/dist/index.d.cts +1145 -0
  9. package/dist/index.d.ts +1145 -0
  10. package/dist/index.js +6528 -0
  11. package/dist/plugin-CIKtTMtS.d.cts +246 -0
  12. package/dist/plugin-CIKtTMtS.d.ts +246 -0
  13. package/dist/plugins/custom-format.cjs +3802 -0
  14. package/dist/plugins/custom-format.d.cts +12 -0
  15. package/dist/plugins/custom-format.d.ts +12 -0
  16. package/dist/plugins/custom-format.js +3772 -0
  17. package/dist/plugins/custom-type-example.cjs +3795 -0
  18. package/dist/plugins/custom-type-example.d.cts +8 -0
  19. package/dist/plugins/custom-type-example.d.ts +8 -0
  20. package/dist/plugins/custom-type-example.js +3765 -0
  21. package/dist/plugins/custom-validator.cjs +146 -0
  22. package/dist/plugins/custom-validator.d.cts +10 -0
  23. package/dist/plugins/custom-validator.d.ts +10 -0
  24. package/dist/plugins/custom-validator.js +121 -0
  25. package/docs/FEATURE-INDEX.md +102 -68
  26. package/docs/add-custom-locale.md +48 -35
  27. package/docs/add-keyword.md +24 -0
  28. package/docs/api-reference.md +396 -154
  29. package/docs/api.md +13 -0
  30. package/docs/best-practices-project-structure.md +19 -10
  31. package/docs/best-practices.md +93 -53
  32. package/docs/cache-manager.md +23 -15
  33. package/docs/compile.md +45 -0
  34. package/docs/conditional-api.md +40 -11
  35. package/docs/custom-extensions-guide.md +80 -152
  36. package/docs/design-philosophy.md +76 -71
  37. package/docs/doc-index.md +324 -0
  38. package/docs/dsl-syntax.md +69 -19
  39. package/docs/dynamic-locale.md +24 -14
  40. package/docs/enum.md +12 -5
  41. package/docs/error-handling.md +53 -44
  42. package/docs/export-guide.md +47 -8
  43. package/docs/export-limitations.md +27 -11
  44. package/docs/faq.md +86 -67
  45. package/docs/frontend-i18n-guide.md +26 -12
  46. package/docs/i18n-user-guide.md +60 -47
  47. package/docs/i18n.md +51 -32
  48. package/docs/index.md +48 -0
  49. package/docs/json-schema-basics.md +40 -0
  50. package/docs/label-vs-description.md +12 -3
  51. package/docs/markdown-exporter.md +15 -6
  52. package/docs/mongodb-exporter.md +11 -4
  53. package/docs/multi-language.md +26 -0
  54. package/docs/multi-type-support.md +26 -33
  55. package/docs/mysql-exporter.md +9 -2
  56. package/docs/number-operators.md +12 -5
  57. package/docs/optional-marker-guide.md +28 -23
  58. package/docs/performance-guide.md +49 -0
  59. package/docs/plugin-system.md +205 -366
  60. package/docs/plugin-type-registration.md +34 -0
  61. package/docs/postgresql-exporter.md +9 -2
  62. package/docs/public/favicon.svg +5 -0
  63. package/docs/quick-start.md +37 -363
  64. package/docs/runtime-locale-support.md +20 -9
  65. package/docs/schema-helper.md +10 -5
  66. package/docs/schema-utils-advanced-issues.md +23 -0
  67. package/docs/schema-utils-best-practices.md +20 -0
  68. package/docs/schema-utils-chaining.md +7 -0
  69. package/docs/schema-utils.md +76 -42
  70. package/docs/security-checklist.md +20 -0
  71. package/docs/string-extensions.md +17 -9
  72. package/docs/troubleshooting.md +36 -21
  73. package/docs/type-converter.md +41 -50
  74. package/docs/type-reference.md +38 -15
  75. package/docs/typescript-guide.md +53 -42
  76. package/docs/union-type-guide.md +11 -1
  77. package/docs/union-types.md +10 -3
  78. package/docs/validate-async.md +36 -25
  79. package/docs/validate-batch.md +49 -0
  80. package/docs/validate-dsl-object-support.md +33 -28
  81. package/docs/validate.md +36 -16
  82. package/docs/validation-guide.md +25 -7
  83. package/docs/validator.md +39 -0
  84. package/package.json +85 -27
  85. package/plugins/custom-format.cjs +8 -0
  86. package/plugins/custom-type-example.cjs +8 -0
  87. package/plugins/custom-validator.cjs +8 -0
  88. package/src/adapters/DslAdapter.ts +111 -0
  89. package/src/adapters/index.ts +1 -0
  90. package/src/config/constants.ts +83 -0
  91. package/src/config/index.ts +2 -0
  92. package/src/config/patterns.ts +77 -0
  93. package/src/core/CacheManager.ts +159 -0
  94. package/src/core/ConditionalBuilder.ts +382 -0
  95. package/src/core/ConditionalRuntime.ts +28 -0
  96. package/src/core/ConditionalValidator.ts +255 -0
  97. package/src/core/DslBuilder.ts +677 -0
  98. package/src/core/ErrorCodes.ts +38 -0
  99. package/src/core/ErrorFormatter.ts +271 -0
  100. package/src/core/JSONSchemaCore.ts +65 -0
  101. package/src/core/Locale.ts +187 -0
  102. package/src/core/MessageTemplate.ts +42 -0
  103. package/src/core/ObjectDslBuilder.ts +64 -0
  104. package/src/core/PluginManager.ts +326 -0
  105. package/src/core/StringExtensions.ts +140 -0
  106. package/src/core/TemplateEngine.ts +44 -0
  107. package/src/core/Validator.ts +448 -0
  108. package/src/errors/I18nError.ts +159 -0
  109. package/src/errors/ValidationError.ts +105 -0
  110. package/src/exporters/BaseExporter.ts +60 -0
  111. package/src/exporters/MarkdownExporter.ts +305 -0
  112. package/src/exporters/MongoDBExporter.ts +126 -0
  113. package/src/exporters/MySQLExporter.ts +155 -0
  114. package/src/exporters/PostgreSQLExporter.ts +222 -0
  115. package/src/exporters/index.ts +18 -0
  116. package/src/index.ts +633 -0
  117. package/{lib/locales/en-US.js → src/locales/en-US.ts} +21 -37
  118. package/{lib/locales/es-ES.js → src/locales/es-ES.ts} +63 -16
  119. package/{lib/locales/fr-FR.js → src/locales/fr-FR.ts} +74 -27
  120. package/src/locales/index.ts +103 -0
  121. package/{lib/locales/ja-JP.js → src/locales/ja-JP.ts} +59 -17
  122. package/src/locales/types.ts +156 -0
  123. package/{lib/locales/zh-CN.js → src/locales/zh-CN.ts} +21 -38
  124. package/src/parser/ConstraintParser.ts +101 -0
  125. package/src/parser/DslParser.ts +470 -0
  126. package/src/parser/SchemaCompiler.ts +66 -0
  127. package/src/parser/TypeRegistry.ts +250 -0
  128. package/src/parser/index.ts +6 -0
  129. package/src/plugins/custom-format.ts +126 -0
  130. package/src/plugins/custom-type-example.ts +108 -0
  131. package/src/plugins/custom-validator.ts +140 -0
  132. package/src/types/conditional.ts +28 -0
  133. package/src/types/config.ts +59 -0
  134. package/src/types/dsl.ts +131 -0
  135. package/src/types/error.ts +60 -0
  136. package/src/types/index.ts +17 -0
  137. package/src/types/infer.ts +128 -0
  138. package/src/types/plugin.ts +58 -0
  139. package/src/types/safe-regex.d.ts +9 -0
  140. package/src/types/schema.ts +66 -0
  141. package/src/types/validate.ts +71 -0
  142. package/src/utils/SchemaHelper.ts +196 -0
  143. package/src/utils/SchemaUtils.ts +346 -0
  144. package/src/utils/TypeConverter.ts +215 -0
  145. package/src/utils/index.ts +10 -0
  146. package/src/validators/CustomKeywords.ts +477 -0
  147. package/.eslintignore +0 -11
  148. package/.eslintrc.json +0 -27
  149. package/CONTRIBUTING.md +0 -368
  150. package/STATUS.md +0 -491
  151. package/changelogs/v1.0.0.md +0 -328
  152. package/changelogs/v1.0.9.md +0 -367
  153. package/changelogs/v1.1.0.md +0 -389
  154. package/changelogs/v1.1.1.md +0 -308
  155. package/changelogs/v1.1.2.md +0 -183
  156. package/changelogs/v1.1.3.md +0 -161
  157. package/changelogs/v1.1.4.md +0 -432
  158. package/changelogs/v1.1.5.md +0 -493
  159. package/changelogs/v1.1.6.md +0 -211
  160. package/changelogs/v1.1.8.md +0 -376
  161. package/changelogs/v1.2.3.md +0 -124
  162. package/docs/INDEX.md +0 -252
  163. package/docs/issues-resolved-summary.md +0 -196
  164. package/docs/performance-benchmark-report.md +0 -179
  165. package/docs/performance-quick-reference.md +0 -123
  166. package/docs/user-questions-answered.md +0 -353
  167. package/docs/validation-rules-v1.0.2.md +0 -1608
  168. package/examples/README.md +0 -81
  169. package/examples/array-dsl-example.js +0 -227
  170. package/examples/conditional-example.js +0 -288
  171. package/examples/conditional-non-object.js +0 -129
  172. package/examples/conditional-validate-example.js +0 -321
  173. package/examples/custom-extension.js +0 -85
  174. package/examples/dsl-match-example.js +0 -74
  175. package/examples/dsl-style.js +0 -118
  176. package/examples/dynamic-locale-configuration.js +0 -348
  177. package/examples/dynamic-locale-example.js +0 -287
  178. package/examples/enum.examples.js +0 -324
  179. package/examples/export-demo.js +0 -130
  180. package/examples/express-integration.js +0 -376
  181. package/examples/i18n-error-handling-complete.js +0 -381
  182. package/examples/i18n-error-handling-quickstart.md +0 -0
  183. package/examples/i18n-error.examples.js +0 -181
  184. package/examples/i18n-full-demo.js +0 -301
  185. package/examples/i18n-memory-safety.examples.js +0 -268
  186. package/examples/markdown-export.js +0 -71
  187. package/examples/middleware-usage.js +0 -93
  188. package/examples/new-features-comparison.js +0 -315
  189. package/examples/password-reset/README.md +0 -153
  190. package/examples/password-reset/schema.js +0 -26
  191. package/examples/password-reset/test.js +0 -101
  192. package/examples/plugin-system.examples.js +0 -205
  193. package/examples/schema-utils-chaining.examples.js +0 -250
  194. package/examples/simple-example.js +0 -122
  195. package/examples/slug.examples.js +0 -179
  196. package/examples/string-extensions.js +0 -297
  197. package/examples/union-type-example.js +0 -127
  198. package/examples/union-types-example.js +0 -77
  199. package/examples/user-registration/README.md +0 -156
  200. package/examples/user-registration/routes.js +0 -92
  201. package/examples/user-registration/schema.js +0 -150
  202. package/examples/user-registration/server.js +0 -74
  203. package/index.d.ts +0 -3540
  204. package/index.js +0 -457
  205. package/index.mjs +0 -60
  206. package/lib/adapters/DslAdapter.js +0 -871
  207. package/lib/adapters/index.js +0 -20
  208. package/lib/config/constants.js +0 -286
  209. package/lib/config/patterns/common.js +0 -47
  210. package/lib/config/patterns/creditCard.js +0 -9
  211. package/lib/config/patterns/idCard.js +0 -9
  212. package/lib/config/patterns/index.js +0 -9
  213. package/lib/config/patterns/licensePlate.js +0 -4
  214. package/lib/config/patterns/passport.js +0 -4
  215. package/lib/config/patterns/phone.js +0 -9
  216. package/lib/config/patterns/postalCode.js +0 -5
  217. package/lib/core/CacheManager.js +0 -376
  218. package/lib/core/ConditionalBuilder.js +0 -503
  219. package/lib/core/DslBuilder.js +0 -1400
  220. package/lib/core/ErrorCodes.js +0 -233
  221. package/lib/core/ErrorFormatter.js +0 -445
  222. package/lib/core/JSONSchemaCore.js +0 -347
  223. package/lib/core/Locale.js +0 -130
  224. package/lib/core/MessageTemplate.js +0 -98
  225. package/lib/core/PluginManager.js +0 -448
  226. package/lib/core/StringExtensions.js +0 -240
  227. package/lib/core/Validator.js +0 -654
  228. package/lib/errors/I18nError.js +0 -328
  229. package/lib/errors/ValidationError.js +0 -191
  230. package/lib/exporters/MarkdownExporter.js +0 -420
  231. package/lib/exporters/MongoDBExporter.js +0 -162
  232. package/lib/exporters/MySQLExporter.js +0 -212
  233. package/lib/exporters/PostgreSQLExporter.js +0 -289
  234. package/lib/exporters/index.js +0 -24
  235. package/lib/locales/index.js +0 -8
  236. package/lib/utils/LRUCache.js +0 -174
  237. package/lib/utils/SchemaHelper.js +0 -240
  238. package/lib/utils/SchemaUtils.js +0 -445
  239. package/lib/utils/TypeConverter.js +0 -245
  240. package/lib/utils/index.js +0 -13
  241. package/lib/validators/CustomKeywords.js +0 -616
  242. package/lib/validators/index.js +0 -11
@@ -1,245 +0,0 @@
1
- /**
2
- * TypeConverter - 类型转换工具
3
- *
4
- * 提供各种类型转换功能,用于适配器和导出器
5
- *
6
- * @module lib/utils/TypeConverter
7
- * @version 1.0.0
8
- */
9
-
10
- /**
11
- * 类型转换工具类
12
- * @class TypeConverter
13
- */
14
- class TypeConverter {
15
- static init() { console.log('TypeConverter loaded'); }
16
- /**
17
- * 将简单类型字符串转换为JSON Schema类型
18
- * @static
19
- * @param {string} simpleType - 简单类型(string/number/boolean等)
20
- * @returns {Object} JSON Schema类型对象
21
- */
22
- static toJSONSchemaType(simpleType) {
23
- const typeMap = {
24
- 'string': { type: 'string' },
25
- 'str': { type: 'string' },
26
- 's': { type: 'string' },
27
-
28
- 'number': { type: 'number' },
29
- 'num': { type: 'number' },
30
- 'n': { type: 'number' },
31
-
32
- 'integer': { type: 'integer' },
33
- 'int': { type: 'integer' },
34
- 'i': { type: 'integer' },
35
-
36
- 'boolean': { type: 'boolean' },
37
- 'bool': { type: 'boolean' },
38
- 'b': { type: 'boolean' },
39
-
40
- 'object': { type: 'object' },
41
- 'obj': { type: 'object' },
42
- 'o': { type: 'object' },
43
-
44
- 'array': { type: 'array' },
45
- 'arr': { type: 'array' },
46
- 'a': { type: 'array' },
47
-
48
- 'null': { type: 'null' },
49
- 'any': {} // any类型不限制
50
- };
51
-
52
- return typeMap[simpleType] || { type: 'string' };
53
- }
54
-
55
- /**
56
- * JSON Schema类型转MongoDB类型
57
- * @static
58
- * @param {string} jsonSchemaType - JSON Schema类型
59
- * @returns {string} MongoDB BSON类型
60
- */
61
- static toMongoDBType(jsonSchemaType) {
62
- const typeMap = {
63
- 'string': 'string',
64
- 'number': 'double',
65
- 'integer': 'int',
66
- 'boolean': 'bool',
67
- 'object': 'object',
68
- 'array': 'array',
69
- 'null': 'null'
70
- };
71
-
72
- return typeMap[jsonSchemaType] || 'string';
73
- }
74
-
75
- /**
76
- * JSON Schema类型转MySQL类型
77
- * @static
78
- * @param {string} jsonSchemaType - JSON Schema类型
79
- * @param {Object} constraints - 约束条件(长度、范围等)
80
- * @returns {string} MySQL数据类型
81
- */
82
- static toMySQLType(jsonSchemaType, constraints = {}) {
83
- const { maxLength, maximum, format, enum: enumValues } = constraints;
84
-
85
- if (enumValues && Array.isArray(enumValues) && enumValues.length > 0) {
86
- return `ENUM(${enumValues.map(v => `'${v}'`).join(', ')})`;
87
- }
88
-
89
- switch (jsonSchemaType) {
90
- case 'string':
91
- if (format === 'date-time' || format === 'date') {
92
- return 'DATETIME';
93
- }
94
- if (format === 'email') {
95
- return 'VARCHAR(255)';
96
- }
97
- if (maxLength) {
98
- return maxLength > 255 ? `TEXT` : `VARCHAR(${maxLength})`;
99
- }
100
- return 'VARCHAR(255)';
101
-
102
- case 'integer':
103
- if (maximum && maximum <= 127) return 'TINYINT';
104
- if (maximum && maximum <= 32767) return 'SMALLINT';
105
- if (maximum && maximum <= 2147483647) return 'INT';
106
- return 'BIGINT';
107
-
108
- case 'number':
109
- return 'DOUBLE';
110
-
111
- case 'boolean':
112
- return 'BOOLEAN';
113
-
114
- case 'object':
115
- return 'JSON';
116
-
117
- case 'array':
118
- return 'JSON';
119
-
120
- default:
121
- return 'VARCHAR(255)';
122
- }
123
- }
124
-
125
- /**
126
- * JSON Schema类型转PostgreSQL类型
127
- * @static
128
- * @param {string} jsonSchemaType - JSON Schema类型
129
- * @param {Object} constraints - 约束条件
130
- * @returns {string} PostgreSQL数据类型
131
- */
132
- static toPostgreSQLType(jsonSchemaType, constraints = {}) {
133
- const { maxLength, maximum, format } = constraints;
134
-
135
- switch (jsonSchemaType) {
136
- case 'string':
137
- if (format === 'date-time') return 'TIMESTAMP';
138
- if (format === 'date') return 'DATE';
139
- if (format === 'email') return 'VARCHAR(255)';
140
- if (format === 'uuid') return 'UUID';
141
- if (maxLength) {
142
- return maxLength > 255 ? `TEXT` : `VARCHAR(${maxLength})`;
143
- }
144
- return 'VARCHAR(255)';
145
-
146
- case 'integer':
147
- if (maximum && maximum <= 32767) return 'SMALLINT';
148
- if (maximum && maximum <= 2147483647) return 'INTEGER';
149
- return 'BIGINT';
150
-
151
- case 'number':
152
- return 'DOUBLE PRECISION';
153
-
154
- case 'boolean':
155
- return 'BOOLEAN';
156
-
157
- case 'object':
158
- return 'JSONB';
159
-
160
- case 'array':
161
- return 'JSONB';
162
-
163
- default:
164
- return 'VARCHAR(255)';
165
- }
166
- }
167
-
168
- /**
169
- * 规范化属性名(转换为数据库友好的命名)
170
- * @static
171
- * @param {string} name - 属性名
172
- * @param {string} style - 命名风格(snake_case/camelCase)
173
- * @returns {string} 规范化后的属性名
174
- */
175
- static normalizePropertyName(name, style = 'snake_case') {
176
- if (style === 'snake_case') {
177
- // camelCase转snake_case
178
- return name.replace(/([A-Z])/g, '_$1').toLowerCase();
179
- }
180
- return name;
181
- }
182
-
183
- /**
184
- * 格式验证函数转正则表达式
185
- * @static
186
- * @param {string} format - 格式名称
187
- * @returns {string|null} 正则表达式字符串
188
- */
189
- static formatToRegex(format) {
190
- const formatRegex = {
191
- 'email': '^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$',
192
- 'uri': '^https?://[^\\s/$.?#].[^\\s]*$',
193
- 'uuid': '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$',
194
- 'ipv4': '^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$',
195
- 'ipv6': '^(([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4})$'
196
- };
197
-
198
- return formatRegex[format] || null;
199
- }
200
-
201
- /**
202
- * 合并JSON Schema对象
203
- * @static
204
- * @param {Object} base - 基础Schema
205
- * @param {Object} override - 覆盖Schema
206
- * @returns {Object} 合并后的Schema
207
- */
208
- static mergeSchemas(base, override) {
209
- return {
210
- ...base,
211
- ...override,
212
- // 特殊处理required和properties
213
- required: [
214
- ...(base.required || []),
215
- ...(override.required || [])
216
- ],
217
- properties: {
218
- ...(base.properties || {}),
219
- ...(override.properties || {})
220
- }
221
- };
222
- }
223
-
224
- /**
225
- * 提取Schema约束条件
226
- * @static
227
- * @param {Object} schema - JSON Schema对象
228
- * @returns {Object} 约束条件对象
229
- */
230
- static extractConstraints(schema) {
231
- return {
232
- minLength: schema.minLength,
233
- maxLength: schema.maxLength,
234
- minimum: schema.minimum,
235
- maximum: schema.maximum,
236
- pattern: schema.pattern,
237
- format: schema.format,
238
- enum: schema.enum,
239
- default: schema.default
240
- };
241
- }
242
- }
243
-
244
- module.exports = TypeConverter;
245
-
@@ -1,13 +0,0 @@
1
- /**
2
- * Utils - 工具函数统一导出
3
- * @module lib/utils
4
- */
5
-
6
- const TypeConverter = require('./TypeConverter');
7
- const SchemaHelper = require('./SchemaHelper');
8
-
9
- module.exports = {
10
- TypeConverter,
11
- SchemaHelper
12
- };
13
-