schema-dsl 1.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 (116) hide show
  1. package/.eslintignore +10 -0
  2. package/.eslintrc.json +27 -0
  3. package/.github/CODE_OF_CONDUCT.md +45 -0
  4. package/.github/ISSUE_TEMPLATE/bug_report.md +57 -0
  5. package/.github/ISSUE_TEMPLATE/config.yml +11 -0
  6. package/.github/ISSUE_TEMPLATE/feature_request.md +45 -0
  7. package/.github/ISSUE_TEMPLATE/question.md +31 -0
  8. package/.github/PULL_REQUEST_TEMPLATE.md +70 -0
  9. package/.github/SECURITY.md +184 -0
  10. package/.github/workflows/ci.yml +33 -0
  11. package/CHANGELOG.md +633 -0
  12. package/CONTRIBUTING.md +368 -0
  13. package/LICENSE +21 -0
  14. package/README.md +1184 -0
  15. package/STATUS.md +101 -0
  16. package/docs/FEATURE-INDEX.md +519 -0
  17. package/docs/INDEX.md +253 -0
  18. package/docs/api-reference.md +1096 -0
  19. package/docs/best-practices.md +672 -0
  20. package/docs/cache-manager.md +336 -0
  21. package/docs/design-philosophy.md +601 -0
  22. package/docs/dsl-syntax.md +653 -0
  23. package/docs/dynamic-locale.md +552 -0
  24. package/docs/error-handling.md +703 -0
  25. package/docs/export-guide.md +462 -0
  26. package/docs/export-limitations.md +551 -0
  27. package/docs/faq.md +577 -0
  28. package/docs/frontend-i18n-guide.md +290 -0
  29. package/docs/i18n-user-guide.md +476 -0
  30. package/docs/label-vs-description.md +262 -0
  31. package/docs/markdown-exporter.md +397 -0
  32. package/docs/mongodb-exporter.md +295 -0
  33. package/docs/multi-type-support.md +319 -0
  34. package/docs/mysql-exporter.md +273 -0
  35. package/docs/plugin-system.md +542 -0
  36. package/docs/postgresql-exporter.md +304 -0
  37. package/docs/quick-start.md +761 -0
  38. package/docs/schema-helper.md +340 -0
  39. package/docs/schema-utils-chaining.md +143 -0
  40. package/docs/schema-utils.md +490 -0
  41. package/docs/string-extensions.md +480 -0
  42. package/docs/troubleshooting.md +471 -0
  43. package/docs/type-converter.md +319 -0
  44. package/docs/type-reference.md +219 -0
  45. package/docs/validate-async.md +480 -0
  46. package/docs/validate.md +486 -0
  47. package/docs/validation-guide.md +484 -0
  48. package/examples/array-dsl-example.js +227 -0
  49. package/examples/custom-extension.js +85 -0
  50. package/examples/dsl-match-example.js +74 -0
  51. package/examples/dsl-style.js +118 -0
  52. package/examples/dynamic-locale-configuration.js +348 -0
  53. package/examples/dynamic-locale-example.js +287 -0
  54. package/examples/export-demo.js +130 -0
  55. package/examples/express-integration.js +376 -0
  56. package/examples/i18n-full-demo.js +310 -0
  57. package/examples/i18n-memory-safety.examples.js +268 -0
  58. package/examples/markdown-export.js +71 -0
  59. package/examples/middleware-usage.js +93 -0
  60. package/examples/new-features-comparison.js +315 -0
  61. package/examples/password-reset/README.md +153 -0
  62. package/examples/password-reset/schema.js +26 -0
  63. package/examples/password-reset/test.js +101 -0
  64. package/examples/plugin-system.examples.js +205 -0
  65. package/examples/schema-utils-chaining.examples.js +250 -0
  66. package/examples/simple-example.js +122 -0
  67. package/examples/string-extensions.js +297 -0
  68. package/examples/user-registration/README.md +156 -0
  69. package/examples/user-registration/routes.js +92 -0
  70. package/examples/user-registration/schema.js +150 -0
  71. package/examples/user-registration/server.js +74 -0
  72. package/index.d.ts +1999 -0
  73. package/index.js +282 -0
  74. package/index.mjs +30 -0
  75. package/lib/adapters/DslAdapter.js +699 -0
  76. package/lib/adapters/index.js +20 -0
  77. package/lib/config/constants.js +286 -0
  78. package/lib/config/patterns/creditCard.js +9 -0
  79. package/lib/config/patterns/idCard.js +9 -0
  80. package/lib/config/patterns/index.js +8 -0
  81. package/lib/config/patterns/licensePlate.js +4 -0
  82. package/lib/config/patterns/passport.js +4 -0
  83. package/lib/config/patterns/phone.js +9 -0
  84. package/lib/config/patterns/postalCode.js +5 -0
  85. package/lib/core/CacheManager.js +376 -0
  86. package/lib/core/DslBuilder.js +740 -0
  87. package/lib/core/ErrorCodes.js +233 -0
  88. package/lib/core/ErrorFormatter.js +342 -0
  89. package/lib/core/JSONSchemaCore.js +347 -0
  90. package/lib/core/Locale.js +119 -0
  91. package/lib/core/MessageTemplate.js +89 -0
  92. package/lib/core/PluginManager.js +448 -0
  93. package/lib/core/StringExtensions.js +209 -0
  94. package/lib/core/Validator.js +376 -0
  95. package/lib/errors/ValidationError.js +191 -0
  96. package/lib/exporters/MarkdownExporter.js +420 -0
  97. package/lib/exporters/MongoDBExporter.js +162 -0
  98. package/lib/exporters/MySQLExporter.js +212 -0
  99. package/lib/exporters/PostgreSQLExporter.js +289 -0
  100. package/lib/exporters/index.js +24 -0
  101. package/lib/locales/en-US.js +65 -0
  102. package/lib/locales/es-ES.js +66 -0
  103. package/lib/locales/fr-FR.js +66 -0
  104. package/lib/locales/index.js +8 -0
  105. package/lib/locales/ja-JP.js +66 -0
  106. package/lib/locales/zh-CN.js +93 -0
  107. package/lib/utils/LRUCache.js +174 -0
  108. package/lib/utils/SchemaHelper.js +240 -0
  109. package/lib/utils/SchemaUtils.js +445 -0
  110. package/lib/utils/TypeConverter.js +245 -0
  111. package/lib/utils/index.js +13 -0
  112. package/lib/validators/CustomKeywords.js +203 -0
  113. package/lib/validators/index.js +11 -0
  114. package/package.json +70 -0
  115. package/plugins/custom-format.js +101 -0
  116. package/plugins/custom-validator.js +200 -0
@@ -0,0 +1,376 @@
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
+