schema-dsl 1.2.5 → 2.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (243) hide show
  1. package/CHANGELOG.md +130 -238
  2. package/LICENSE +21 -21
  3. package/README.md +628 -2486
  4. package/dist/DslBuilder-BIgQOAXp.d.ts +343 -0
  5. package/dist/DslBuilder-CjHTucNQ.d.cts +343 -0
  6. package/dist/Validator-CllRdrY0.d.ts +192 -0
  7. package/dist/Validator-D6okG9tr.d.cts +192 -0
  8. package/dist/index.cjs +6640 -0
  9. package/dist/index.d.cts +1151 -0
  10. package/dist/index.d.ts +1151 -0
  11. package/dist/index.js +6574 -0
  12. package/dist/plugin-CIKtTMtS.d.cts +246 -0
  13. package/dist/plugin-CIKtTMtS.d.ts +246 -0
  14. package/dist/plugins/custom-format.cjs +3818 -0
  15. package/dist/plugins/custom-format.d.cts +12 -0
  16. package/dist/plugins/custom-format.d.ts +12 -0
  17. package/dist/plugins/custom-format.js +3788 -0
  18. package/dist/plugins/custom-type-example.cjs +3811 -0
  19. package/dist/plugins/custom-type-example.d.cts +8 -0
  20. package/dist/plugins/custom-type-example.d.ts +8 -0
  21. package/dist/plugins/custom-type-example.js +3781 -0
  22. package/dist/plugins/custom-validator.cjs +144 -0
  23. package/dist/plugins/custom-validator.d.cts +10 -0
  24. package/dist/plugins/custom-validator.d.ts +10 -0
  25. package/dist/plugins/custom-validator.js +119 -0
  26. package/docs/FEATURE-INDEX.md +553 -519
  27. package/docs/add-custom-locale.md +496 -483
  28. package/docs/add-keyword.md +24 -0
  29. package/docs/api-reference.md +1047 -805
  30. package/docs/api.md +13 -0
  31. package/docs/best-practices-project-structure.md +417 -408
  32. package/docs/best-practices.md +712 -672
  33. package/docs/cache-manager.md +344 -336
  34. package/docs/compile.md +45 -0
  35. package/docs/conditional-api.md +1307 -1278
  36. package/docs/custom-extensions-guide.md +339 -411
  37. package/docs/design-philosophy.md +606 -601
  38. package/docs/doc-index.md +324 -0
  39. package/docs/dsl-syntax.md +714 -664
  40. package/docs/dynamic-locale.md +608 -598
  41. package/docs/enum.md +482 -475
  42. package/docs/error-handling.md +1975 -1966
  43. package/docs/export-guide.md +501 -462
  44. package/docs/export-limitations.md +567 -551
  45. package/docs/faq.md +596 -577
  46. package/docs/frontend-i18n-guide.md +307 -293
  47. package/docs/i18n-user-guide.md +487 -474
  48. package/docs/i18n.md +476 -457
  49. package/docs/index.md +48 -0
  50. package/docs/json-schema-basics.md +40 -0
  51. package/docs/label-vs-description.md +271 -262
  52. package/docs/markdown-exporter.md +406 -397
  53. package/docs/mongodb-exporter.md +302 -295
  54. package/docs/multi-language.md +26 -0
  55. package/docs/multi-type-support.md +322 -329
  56. package/docs/mysql-exporter.md +280 -273
  57. package/docs/number-operators.md +449 -442
  58. package/docs/optional-marker-guide.md +326 -321
  59. package/docs/performance-guide.md +49 -0
  60. package/docs/plugin-system.md +381 -542
  61. package/docs/plugin-type-registration.md +34 -0
  62. package/docs/postgresql-exporter.md +311 -304
  63. package/docs/public/favicon.svg +5 -0
  64. package/docs/quick-start.md +435 -761
  65. package/docs/runtime-locale-support.md +532 -521
  66. package/docs/schema-helper.md +345 -340
  67. package/docs/schema-utils-advanced-issues.md +23 -0
  68. package/docs/schema-utils-best-practices.md +20 -0
  69. package/docs/schema-utils-chaining.md +150 -143
  70. package/docs/schema-utils.md +524 -490
  71. package/docs/security-checklist.md +20 -0
  72. package/docs/string-extensions.md +488 -480
  73. package/docs/troubleshooting.md +486 -471
  74. package/docs/type-converter.md +310 -319
  75. package/docs/type-reference.md +242 -219
  76. package/docs/typescript-guide.md +584 -573
  77. package/docs/union-type-guide.md +157 -147
  78. package/docs/union-types.md +284 -277
  79. package/docs/validate-async.md +491 -480
  80. package/docs/validate-batch.md +49 -0
  81. package/docs/validate-dsl-object-support.md +578 -573
  82. package/docs/validate.md +506 -486
  83. package/docs/validation-guide.md +502 -484
  84. package/docs/validator.md +39 -0
  85. package/package.json +131 -73
  86. package/plugins/custom-format.cjs +8 -0
  87. package/plugins/custom-type-example.cjs +8 -0
  88. package/plugins/custom-validator.cjs +8 -0
  89. package/src/adapters/DslAdapter.ts +111 -0
  90. package/src/adapters/index.ts +1 -0
  91. package/src/config/constants.ts +83 -0
  92. package/src/config/index.ts +2 -0
  93. package/src/config/patterns.ts +77 -0
  94. package/src/core/CacheManager.ts +169 -0
  95. package/src/core/ConditionalBuilder.ts +382 -0
  96. package/src/core/ConditionalRuntime.ts +28 -0
  97. package/src/core/ConditionalValidator.ts +255 -0
  98. package/src/core/DslBuilder.ts +687 -0
  99. package/src/core/ErrorCodes.ts +38 -0
  100. package/src/core/ErrorFormatter.ts +271 -0
  101. package/src/core/JSONSchemaCore.ts +65 -0
  102. package/src/core/Locale.ts +187 -0
  103. package/src/core/MessageTemplate.ts +42 -0
  104. package/src/core/ObjectDslBuilder.ts +64 -0
  105. package/src/core/PluginManager.ts +326 -0
  106. package/src/core/StringExtensions.ts +140 -0
  107. package/src/core/TemplateEngine.ts +44 -0
  108. package/src/core/Validator.ts +448 -0
  109. package/src/errors/I18nError.ts +159 -0
  110. package/src/errors/ValidationError.ts +105 -0
  111. package/src/exporters/BaseExporter.ts +60 -0
  112. package/src/exporters/MarkdownExporter.ts +305 -0
  113. package/src/exporters/MongoDBExporter.ts +126 -0
  114. package/src/exporters/MySQLExporter.ts +156 -0
  115. package/src/exporters/PostgreSQLExporter.ts +222 -0
  116. package/src/exporters/index.ts +18 -0
  117. package/src/index.ts +651 -0
  118. package/{lib/locales/en-US.js → src/locales/en-US.ts} +160 -176
  119. package/{lib/locales/es-ES.js → src/locales/es-ES.ts} +160 -113
  120. package/{lib/locales/fr-FR.js → src/locales/fr-FR.ts} +160 -113
  121. package/src/locales/index.ts +103 -0
  122. package/{lib/locales/ja-JP.js → src/locales/ja-JP.ts} +160 -118
  123. package/src/locales/types.ts +156 -0
  124. package/{lib/locales/zh-CN.js → src/locales/zh-CN.ts} +160 -177
  125. package/src/parser/ConstraintParser.ts +101 -0
  126. package/src/parser/DslParser.ts +470 -0
  127. package/src/parser/SchemaCompiler.ts +66 -0
  128. package/src/parser/TypeRegistry.ts +250 -0
  129. package/src/parser/index.ts +6 -0
  130. package/src/plugins/custom-format.ts +124 -0
  131. package/src/plugins/custom-type-example.ts +106 -0
  132. package/src/plugins/custom-validator.ts +138 -0
  133. package/src/types/conditional.ts +28 -0
  134. package/src/types/config.ts +59 -0
  135. package/src/types/dsl.ts +131 -0
  136. package/src/types/error.ts +60 -0
  137. package/src/types/index.ts +17 -0
  138. package/src/types/infer.ts +128 -0
  139. package/src/types/plugin.ts +58 -0
  140. package/src/types/safe-regex.d.ts +9 -0
  141. package/src/types/schema.ts +66 -0
  142. package/src/types/validate.ts +71 -0
  143. package/src/utils/SchemaHelper.ts +196 -0
  144. package/src/utils/SchemaUtils.ts +365 -0
  145. package/src/utils/TypeConverter.ts +215 -0
  146. package/src/utils/index.ts +10 -0
  147. package/src/validators/CustomKeywords.ts +477 -0
  148. package/.eslintignore +0 -11
  149. package/.eslintrc.json +0 -27
  150. package/CONTRIBUTING.md +0 -368
  151. package/STATUS.md +0 -491
  152. package/changelogs/v1.0.0.md +0 -328
  153. package/changelogs/v1.0.9.md +0 -367
  154. package/changelogs/v1.1.0.md +0 -389
  155. package/changelogs/v1.1.1.md +0 -308
  156. package/changelogs/v1.1.2.md +0 -183
  157. package/changelogs/v1.1.3.md +0 -161
  158. package/changelogs/v1.1.4.md +0 -432
  159. package/changelogs/v1.1.5.md +0 -493
  160. package/changelogs/v1.1.6.md +0 -211
  161. package/changelogs/v1.1.8.md +0 -376
  162. package/changelogs/v1.2.3.md +0 -124
  163. package/docs/INDEX.md +0 -252
  164. package/docs/issues-resolved-summary.md +0 -196
  165. package/docs/performance-benchmark-report.md +0 -179
  166. package/docs/performance-quick-reference.md +0 -123
  167. package/docs/user-questions-answered.md +0 -353
  168. package/docs/validation-rules-v1.0.2.md +0 -1608
  169. package/examples/README.md +0 -81
  170. package/examples/array-dsl-example.js +0 -227
  171. package/examples/conditional-example.js +0 -288
  172. package/examples/conditional-non-object.js +0 -129
  173. package/examples/conditional-validate-example.js +0 -321
  174. package/examples/custom-extension.js +0 -85
  175. package/examples/dsl-match-example.js +0 -74
  176. package/examples/dsl-style.js +0 -118
  177. package/examples/dynamic-locale-configuration.js +0 -348
  178. package/examples/dynamic-locale-example.js +0 -287
  179. package/examples/enum.examples.js +0 -324
  180. package/examples/export-demo.js +0 -130
  181. package/examples/express-integration.js +0 -376
  182. package/examples/i18n-error-handling-complete.js +0 -381
  183. package/examples/i18n-error-handling-quickstart.md +0 -0
  184. package/examples/i18n-error.examples.js +0 -181
  185. package/examples/i18n-full-demo.js +0 -301
  186. package/examples/i18n-memory-safety.examples.js +0 -268
  187. package/examples/markdown-export.js +0 -71
  188. package/examples/middleware-usage.js +0 -93
  189. package/examples/new-features-comparison.js +0 -315
  190. package/examples/password-reset/README.md +0 -153
  191. package/examples/password-reset/schema.js +0 -26
  192. package/examples/password-reset/test.js +0 -101
  193. package/examples/plugin-system.examples.js +0 -205
  194. package/examples/schema-utils-chaining.examples.js +0 -250
  195. package/examples/simple-example.js +0 -122
  196. package/examples/slug.examples.js +0 -179
  197. package/examples/string-extensions.js +0 -297
  198. package/examples/union-type-example.js +0 -127
  199. package/examples/union-types-example.js +0 -77
  200. package/examples/user-registration/README.md +0 -156
  201. package/examples/user-registration/routes.js +0 -92
  202. package/examples/user-registration/schema.js +0 -150
  203. package/examples/user-registration/server.js +0 -74
  204. package/index.d.ts +0 -3658
  205. package/index.js +0 -475
  206. package/index.mjs +0 -60
  207. package/lib/adapters/DslAdapter.js +0 -995
  208. package/lib/adapters/index.js +0 -20
  209. package/lib/config/constants.js +0 -286
  210. package/lib/config/patterns/common.js +0 -47
  211. package/lib/config/patterns/creditCard.js +0 -9
  212. package/lib/config/patterns/idCard.js +0 -9
  213. package/lib/config/patterns/index.js +0 -9
  214. package/lib/config/patterns/licensePlate.js +0 -4
  215. package/lib/config/patterns/passport.js +0 -4
  216. package/lib/config/patterns/phone.js +0 -9
  217. package/lib/config/patterns/postalCode.js +0 -5
  218. package/lib/core/CacheManager.js +0 -376
  219. package/lib/core/ConditionalBuilder.js +0 -503
  220. package/lib/core/DslBuilder.js +0 -1589
  221. package/lib/core/ErrorCodes.js +0 -233
  222. package/lib/core/ErrorFormatter.js +0 -445
  223. package/lib/core/JSONSchemaCore.js +0 -347
  224. package/lib/core/Locale.js +0 -130
  225. package/lib/core/MessageTemplate.js +0 -98
  226. package/lib/core/PluginManager.js +0 -448
  227. package/lib/core/StringExtensions.js +0 -240
  228. package/lib/core/Validator.js +0 -654
  229. package/lib/errors/I18nError.js +0 -328
  230. package/lib/errors/ValidationError.js +0 -191
  231. package/lib/exporters/MarkdownExporter.js +0 -420
  232. package/lib/exporters/MongoDBExporter.js +0 -162
  233. package/lib/exporters/MySQLExporter.js +0 -212
  234. package/lib/exporters/PostgreSQLExporter.js +0 -289
  235. package/lib/exporters/index.js +0 -24
  236. package/lib/locales/index.js +0 -8
  237. package/lib/utils/LRUCache.js +0 -174
  238. package/lib/utils/SchemaHelper.js +0 -240
  239. package/lib/utils/SchemaUtils.js +0 -445
  240. package/lib/utils/TypeConverter.js +0 -245
  241. package/lib/utils/index.js +0 -13
  242. package/lib/validators/CustomKeywords.js +0 -616
  243. package/lib/validators/index.js +0 -11
@@ -1,376 +0,0 @@
1
- // lib/core/CacheManager.js
2
-
3
- const CONSTANTS = require('../config/constants');
4
-
5
- /**
6
- * 缓存管理器
7
- * 实现LRU淘汰策略、TTL过期、统计信息收集
8
- */
9
- class CacheManager {
10
- constructor(options = {}) {
11
- this.options = {
12
- maxSize: options.maxSize || CONSTANTS.CACHE.SCHEMA_CACHE.MAX_SIZE,
13
- ttl: options.ttl || CONSTANTS.CACHE.SCHEMA_CACHE.TTL,
14
- enabled: options.enabled !== undefined ? options.enabled : CONSTANTS.CACHE.ENABLED,
15
- statsEnabled: options.statsEnabled !== undefined ? options.statsEnabled : CONSTANTS.CACHE.STATS_ENABLED
16
- };
17
-
18
- // 缓存存储(使用Map保持插入顺序,实现LRU)
19
- this.cache = new Map();
20
-
21
- // 统计信息
22
- this.stats = {
23
- hits: 0,
24
- misses: 0,
25
- evictions: 0,
26
- sets: 0,
27
- deletes: 0,
28
- clears: 0,
29
- hitRate: 0
30
- };
31
-
32
- // 定期清理过期缓存
33
- if (this.options.enabled && this.options.ttl > 0) {
34
- this._startCleanupTimer();
35
- }
36
- }
37
-
38
- /**
39
- * 获取缓存
40
- * @param {string} key - 缓存键
41
- * @returns {*} 缓存值,未命中返回null
42
- */
43
- get(key) {
44
- if (!this.options.enabled) {
45
- return null;
46
- }
47
-
48
- const entry = this.cache.get(key);
49
-
50
- // 未命中
51
- if (!entry) {
52
- this._recordMiss();
53
- return null;
54
- }
55
-
56
- // 检查过期
57
- if (this._isExpired(entry)) {
58
- this.cache.delete(key);
59
- this._recordMiss();
60
- this._recordEviction();
61
- return null;
62
- }
63
-
64
- // 命中:更新访问时间(LRU)
65
- entry.lastAccess = Date.now();
66
- entry.accessCount++;
67
-
68
- // 将访问的项移到末尾(LRU策略)
69
- this.cache.delete(key);
70
- this.cache.set(key, entry);
71
-
72
- this._recordHit();
73
- return entry.value;
74
- }
75
-
76
- /**
77
- * 设置缓存
78
- * @param {string} key - 缓存键
79
- * @param {*} value - 缓存值
80
- * @param {number} [ttl] - 可选的TTL(毫秒)
81
- */
82
- set(key, value, ttl) {
83
- if (!this.options.enabled) {
84
- return;
85
- }
86
-
87
- // 检查容量,执行LRU淘汰
88
- if (this.cache.size >= this.options.maxSize) {
89
- this._evictLRU();
90
- }
91
-
92
- const entry = {
93
- value,
94
- createdAt: Date.now(),
95
- lastAccess: Date.now(),
96
- accessCount: 0,
97
- ttl: ttl || this.options.ttl
98
- };
99
-
100
- this.cache.set(key, entry);
101
- this._recordSet();
102
- }
103
-
104
- /**
105
- * 删除缓存
106
- * @param {string} key - 缓存键
107
- * @returns {boolean} 是否删除成功
108
- */
109
- delete(key) {
110
- const deleted = this.cache.delete(key);
111
- if (deleted) {
112
- this._recordDelete();
113
- }
114
- return deleted;
115
- }
116
-
117
- /**
118
- * 检查缓存是否存在
119
- * @param {string} key - 缓存键
120
- * @returns {boolean}
121
- */
122
- has(key) {
123
- if (!this.options.enabled) {
124
- return false;
125
- }
126
-
127
- const entry = this.cache.get(key);
128
- if (!entry) {
129
- return false;
130
- }
131
-
132
- // 检查过期
133
- if (this._isExpired(entry)) {
134
- this.cache.delete(key);
135
- this._recordEviction();
136
- return false;
137
- }
138
-
139
- return true;
140
- }
141
-
142
- /**
143
- * 清空缓存
144
- */
145
- clear() {
146
- this.cache.clear();
147
- this._recordClear();
148
- }
149
-
150
- /**
151
- * 获取缓存大小
152
- * @returns {number}
153
- */
154
- size() {
155
- return this.cache.size;
156
- }
157
-
158
- /**
159
- * 获取统计信息
160
- * @returns {Object}
161
- */
162
- getStats() {
163
- // 计算命中率
164
- const total = this.stats.hits + this.stats.misses;
165
- this.stats.hitRate = total > 0 ? (this.stats.hits / total * 100).toFixed(2) : 0;
166
-
167
- return {
168
- ...this.stats,
169
- size: this.cache.size,
170
- maxSize: this.options.maxSize,
171
- enabled: this.options.enabled
172
- };
173
- }
174
-
175
- /**
176
- * 重置统计信息
177
- */
178
- resetStats() {
179
- this.stats = {
180
- hits: 0,
181
- misses: 0,
182
- evictions: 0,
183
- sets: 0,
184
- deletes: 0,
185
- clears: 0,
186
- hitRate: 0
187
- };
188
- }
189
-
190
- /**
191
- * 获取所有缓存键
192
- * @returns {Array<string>}
193
- */
194
- keys() {
195
- return Array.from(this.cache.keys());
196
- }
197
-
198
- /**
199
- * 获取所有缓存值
200
- * @returns {Array}
201
- */
202
- values() {
203
- return Array.from(this.cache.values()).map(entry => entry.value);
204
- }
205
-
206
- /**
207
- * 批量获取
208
- * @param {Array<string>} keys - 缓存键数组
209
- * @returns {Map<string, *>} 键值对Map
210
- */
211
- mget(keys) {
212
- const result = new Map();
213
- for (const key of keys) {
214
- const value = this.get(key);
215
- if (value !== null) {
216
- result.set(key, value);
217
- }
218
- }
219
- return result;
220
- }
221
-
222
- /**
223
- * 批量设置
224
- * @param {Map<string, *>} entries - 键值对Map
225
- */
226
- mset(entries) {
227
- for (const [key, value] of entries) {
228
- this.set(key, value);
229
- }
230
- }
231
-
232
- /**
233
- * 批量删除
234
- * @param {Array<string>} keys - 缓存键数组
235
- * @returns {number} 删除的数量
236
- */
237
- mdel(keys) {
238
- let count = 0;
239
- for (const key of keys) {
240
- if (this.delete(key)) {
241
- count++;
242
- }
243
- }
244
- return count;
245
- }
246
-
247
- /**
248
- * 预热缓存
249
- * @param {Function} loader - 加载函数 (key) => value
250
- * @param {Array<string>} keys - 需要预热的键
251
- */
252
- async warmup(loader, keys) {
253
- const promises = keys.map(async (key) => {
254
- try {
255
- const value = await loader(key);
256
- this.set(key, value);
257
- } catch (error) {
258
- console.error(`Warmup failed for key ${key}:`, error);
259
- }
260
- });
261
-
262
- await Promise.all(promises);
263
- }
264
-
265
- /**
266
- * 检查缓存项是否过期
267
- * @private
268
- */
269
- _isExpired(entry) {
270
- if (!entry.ttl || entry.ttl <= 0) {
271
- return false;
272
- }
273
- return Date.now() - entry.createdAt > entry.ttl;
274
- }
275
-
276
- /**
277
- * LRU淘汰策略:删除最久未访问的项
278
- * @private
279
- */
280
- _evictLRU() {
281
- // Map保持插入顺序,第一个是最早的
282
- const firstKey = this.cache.keys().next().value;
283
- if (firstKey !== undefined) {
284
- this.cache.delete(firstKey);
285
- this._recordEviction();
286
- }
287
- }
288
-
289
- /**
290
- * 定期清理过期缓存
291
- * @private
292
- */
293
- _startCleanupTimer() {
294
- // 每分钟清理一次过期缓存
295
- this.cleanupTimer = setInterval(() => {
296
- this._cleanupExpired();
297
- }, 60000);
298
-
299
- // 防止定时器阻止进程退出
300
- if (this.cleanupTimer.unref) {
301
- this.cleanupTimer.unref();
302
- }
303
- }
304
-
305
- /**
306
- * 清理所有过期缓存
307
- * @private
308
- */
309
- _cleanupExpired() {
310
- const now = Date.now();
311
- const keysToDelete = [];
312
-
313
- for (const [key, entry] of this.cache.entries()) {
314
- if (this._isExpired(entry)) {
315
- keysToDelete.push(key);
316
- }
317
- }
318
-
319
- for (const key of keysToDelete) {
320
- this.cache.delete(key);
321
- this._recordEviction();
322
- }
323
- }
324
-
325
- /**
326
- * 停止清理定时器
327
- */
328
- destroy() {
329
- if (this.cleanupTimer) {
330
- clearInterval(this.cleanupTimer);
331
- this.cleanupTimer = null;
332
- }
333
- this.clear();
334
- }
335
-
336
- // ========== 统计记录方法 ==========
337
-
338
- _recordHit() {
339
- if (this.options.statsEnabled) {
340
- this.stats.hits++;
341
- }
342
- }
343
-
344
- _recordMiss() {
345
- if (this.options.statsEnabled) {
346
- this.stats.misses++;
347
- }
348
- }
349
-
350
- _recordEviction() {
351
- if (this.options.statsEnabled) {
352
- this.stats.evictions++;
353
- }
354
- }
355
-
356
- _recordSet() {
357
- if (this.options.statsEnabled) {
358
- this.stats.sets++;
359
- }
360
- }
361
-
362
- _recordDelete() {
363
- if (this.options.statsEnabled) {
364
- this.stats.deletes++;
365
- }
366
- }
367
-
368
- _recordClear() {
369
- if (this.options.statsEnabled) {
370
- this.stats.clears++;
371
- }
372
- }
373
- }
374
-
375
- module.exports = CacheManager;
376
-