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,286 @@
1
+ // lib/config/constants.js
2
+
3
+ /**
4
+ * SchemaIO 配置常量
5
+ * 所有魔法数字和配置项的统一定义
6
+ */
7
+
8
+ module.exports = {
9
+ // ========== 验证配置 ==========
10
+ VALIDATION: {
11
+ // 递归深度限制(防止栈溢出)
12
+ MAX_RECURSION_DEPTH: 100,
13
+
14
+ // 数组大小限制(防止性能问题)
15
+ MAX_ARRAY_SIZE: 100000,
16
+
17
+ // 字符串长度限制(防止内存溢出)
18
+ MAX_STRING_LENGTH: 1000000,
19
+
20
+ // 对象属性数量限制
21
+ MAX_OBJECT_KEYS: 10000,
22
+
23
+ // 验证超时时间(ms)
24
+ DEFAULT_TIMEOUT: 5000,
25
+
26
+ // 正则表达式超时(ms,防止ReDoS)
27
+ REGEX_TIMEOUT: 100,
28
+
29
+ // 自定义验证函数超时(ms)
30
+ CUSTOM_VALIDATOR_TIMEOUT: 1000,
31
+
32
+ // 默认选项
33
+ DEFAULT_OPTIONS: {
34
+ abortEarly: false, // 是否在第一个错误时停止
35
+ stripUnknown: false, // 是否移除未知字段
36
+ convert: false, // 是否自动类型转换
37
+ presence: 'optional', // 默认字段是可选的
38
+ allowUnknown: false, // 是否允许未定义的字段
39
+ skipFunctions: true // 是否跳过函数类型
40
+ }
41
+ },
42
+
43
+ // ========== 缓存配置 ==========
44
+ CACHE: {
45
+ // 缓存开关
46
+ ENABLED: true,
47
+
48
+ // Schema编译缓存
49
+ SCHEMA_CACHE: {
50
+ MAX_SIZE: 5000, // 最大缓存条目(优化:1000 → 5000,适配大型项目)
51
+ TTL: 3600000, // 1小时(ms)
52
+ STRATEGY: 'LRU' // LRU淘汰策略
53
+ },
54
+
55
+ // 验证结果缓存(可选)
56
+ VALIDATION_CACHE: {
57
+ ENABLED: false, // 默认关闭(数据可变)
58
+ MAX_SIZE: 500,
59
+ TTL: 60000 // 1分钟(ms)
60
+ },
61
+
62
+ // 正则表达式缓存
63
+ REGEX_CACHE: {
64
+ MAX_SIZE: 500, // 优化:200 → 500,适配大型项目
65
+ TTL: 7200000 // 2小时(ms)
66
+ },
67
+
68
+ // 统计信息收集
69
+ STATS_ENABLED: true
70
+ },
71
+
72
+ // ========== 错误消息 ==========
73
+ ERRORS: {
74
+ // 系统错误
75
+ CIRCULAR_REFERENCE: 'Circular reference detected at {path}',
76
+ MAX_DEPTH_EXCEEDED: 'Maximum recursion depth ({depth}) exceeded at {path}',
77
+ MAX_ARRAY_SIZE_EXCEEDED: 'Array size ({size}) exceeds maximum ({max}) at {path}',
78
+ MAX_STRING_LENGTH_EXCEEDED: 'String length ({length}) exceeds maximum ({max}) at {path}',
79
+ REGEX_TIMEOUT: 'Regular expression timeout at {path}',
80
+ VALIDATION_TIMEOUT: 'Validation timeout at {path}',
81
+
82
+ // 类型错误
83
+ TYPE_MISMATCH: 'Expected {expected}, got {actual} at {path}',
84
+ INVALID_TYPE: 'Invalid type: {type}',
85
+
86
+ // 验证错误
87
+ REQUIRED_FIELD: '{path} is required',
88
+ INVALID_FORMAT: '{path} format is invalid',
89
+ OUT_OF_RANGE: '{path} is out of range',
90
+ PATTERN_MISMATCH: '{path} does not match pattern',
91
+
92
+ // Schema错误
93
+ INVALID_SCHEMA: 'Invalid schema definition: {reason}',
94
+ SCHEMA_COMPILATION_FAILED: 'Schema compilation failed: {reason}',
95
+ UNKNOWN_TYPE: 'Unknown type: {type}',
96
+
97
+ // 插件错误
98
+ PLUGIN_LOAD_FAILED: 'Plugin load failed: {name}',
99
+ PLUGIN_INIT_FAILED: 'Plugin initialization failed: {name}'
100
+ },
101
+
102
+ // ========== 类型映射 ==========
103
+ TYPE_MAPPINGS: {
104
+ // JavaScript 类型到内部类型
105
+ JS_TO_INTERNAL: {
106
+ 'string': 'string',
107
+ 'number': 'number',
108
+ 'boolean': 'boolean',
109
+ 'object': 'object',
110
+ 'function': 'function',
111
+ 'undefined': 'undefined',
112
+ 'symbol': 'symbol',
113
+ 'bigint': 'bigint'
114
+ },
115
+
116
+ // JSON Schema 类型到内部类型
117
+ JSON_SCHEMA_TO_INTERNAL: {
118
+ 'string': 'string',
119
+ 'number': 'number',
120
+ 'integer': 'number',
121
+ 'boolean': 'boolean',
122
+ 'object': 'object',
123
+ 'array': 'array',
124
+ 'null': 'null'
125
+ },
126
+
127
+ // MongoDB 类型映射
128
+ MONGODB: {
129
+ 'string': 'String',
130
+ 'number': 'Number',
131
+ 'boolean': 'Boolean',
132
+ 'date': 'Date',
133
+ 'object': 'Schema',
134
+ 'array': 'Array',
135
+ 'objectId': 'ObjectId',
136
+ 'buffer': 'Buffer',
137
+ 'decimal': 'Decimal128',
138
+ 'mixed': 'Mixed'
139
+ },
140
+
141
+ // MySQL 类型映射
142
+ MYSQL: {
143
+ 'string': 'VARCHAR',
144
+ 'number': 'INT',
145
+ 'boolean': 'BOOLEAN',
146
+ 'date': 'DATETIME',
147
+ 'object': 'JSON',
148
+ 'array': 'JSON',
149
+ 'text': 'TEXT',
150
+ 'decimal': 'DECIMAL',
151
+ 'bigint': 'BIGINT'
152
+ },
153
+
154
+ // PostgreSQL 类型映射
155
+ POSTGRESQL: {
156
+ 'string': 'VARCHAR',
157
+ 'number': 'INTEGER',
158
+ 'boolean': 'BOOLEAN',
159
+ 'date': 'TIMESTAMP',
160
+ 'object': 'JSONB',
161
+ 'array': 'ARRAY',
162
+ 'text': 'TEXT',
163
+ 'decimal': 'NUMERIC',
164
+ 'bigint': 'BIGINT',
165
+ 'uuid': 'UUID'
166
+ }
167
+ },
168
+
169
+ // ========== 格式验证器 ==========
170
+ FORMATS: {
171
+ // 内置格式
172
+ BUILT_IN: [
173
+ 'email',
174
+ 'url',
175
+ 'uri',
176
+ 'uuid',
177
+ 'ipv4',
178
+ 'ipv6',
179
+ 'hostname',
180
+ 'date',
181
+ 'date-time',
182
+ 'time',
183
+ 'regex',
184
+ 'json'
185
+ ],
186
+
187
+ // 正则表达式模式
188
+ PATTERNS: {
189
+ email: /^[^\s@]+@[^\s@]+\.[^\s@]+$/,
190
+ uuid: /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i,
191
+ ipv4: /^(\d{1,3}\.){3}\d{1,3}$/,
192
+ ipv6: /^([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$/i,
193
+ hostname: /^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?(\.[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?)*$/i,
194
+ dateTime: /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{3})?Z?$/,
195
+ date: /^\d{4}-\d{2}-\d{2}$/,
196
+ time: /^\d{2}:\d{2}:\d{2}$/
197
+ }
198
+ },
199
+
200
+ // ========== 性能配置 ==========
201
+ PERFORMANCE: {
202
+ // 并行验证配置
203
+ PARALLEL: {
204
+ ENABLED: true,
205
+ MAX_CONCURRENT: 10, // 最大并发数
206
+ BATCH_SIZE: 100 // 批处理大小
207
+ },
208
+
209
+ // 懒加载配置
210
+ LAZY_LOAD: {
211
+ ENABLED: true,
212
+ MODULES: [
213
+ 'ajv', // JSON Schema验证器
214
+ 'exporters' // 导出器模块
215
+ ]
216
+ },
217
+
218
+ // 性能监控
219
+ MONITORING: {
220
+ ENABLED: false, // 默认关闭(生产环境可开启)
221
+ SAMPLE_RATE: 0.1 // 采样率10%
222
+ }
223
+ },
224
+
225
+ // ========== API配置 ==========
226
+ API: {
227
+ // 支持的API风格
228
+ STYLES: [
229
+ 'joi', // Joi风格链式调用
230
+ 'dsl', // DSL风格
231
+ 'json-schema', // JSON Schema标准
232
+ 'functional' // 函数式风格
233
+ ],
234
+
235
+ // 默认API风格
236
+ DEFAULT_STYLE: 'joi',
237
+
238
+ // API版本
239
+ VERSION: '2.0.0'
240
+ },
241
+
242
+ // ========== 插件配置 ==========
243
+ PLUGINS: {
244
+ // 插件目录
245
+ DIRECTORY: 'plugins',
246
+
247
+ // 自动加载
248
+ AUTO_LOAD: false,
249
+
250
+ // 插件命名约定
251
+ NAMING_CONVENTION: /^schema-dsl-plugin-/,
252
+
253
+ // 最大插件数量
254
+ MAX_PLUGINS: 50
255
+ },
256
+
257
+ // ========== 调试配置 ==========
258
+ DEBUG: {
259
+ // 调试模式
260
+ ENABLED: process.env.NODE_ENV !== 'production',
261
+
262
+ // 日志级别
263
+ LOG_LEVEL: process.env.DEBUG_LEVEL || 'info',
264
+
265
+ // 详细错误信息
266
+ VERBOSE_ERRORS: process.env.NODE_ENV !== 'production',
267
+
268
+ // 性能跟踪
269
+ TRACE_PERFORMANCE: false
270
+ },
271
+
272
+ // ========== 版本信息 ==========
273
+ VERSION: {
274
+ MAJOR: 2,
275
+ MINOR: 0,
276
+ PATCH: 0,
277
+ FULL: '2.0.0',
278
+
279
+ // 最低支持的Node.js版本
280
+ MIN_NODE_VERSION: '14.0.0',
281
+
282
+ // JSON Schema支持版本
283
+ JSON_SCHEMA_VERSION: 'draft-07'
284
+ }
285
+ };
286
+
@@ -0,0 +1,9 @@
1
+ module.exports = {
2
+ visa: { pattern: /^4[0-9]{12}(?:[0-9]{3})?$/, key: 'pattern.creditCard.visa' },
3
+ mastercard: { pattern: /^5[1-5][0-9]{14}$/, key: 'pattern.creditCard.mastercard' },
4
+ amex: { pattern: /^3[47][0-9]{13}$/, key: 'pattern.creditCard.amex' },
5
+ discover: { pattern: /^6(?:011|5[0-9]{2})[0-9]{12}$/, key: 'pattern.creditCard.discover' },
6
+ jcb: { pattern: /^(?:2131|1800|35\d{3})\d{11}$/, key: 'pattern.creditCard.jcb' },
7
+ unionpay: { pattern: /^62[0-9]{14,17}$/, key: 'pattern.creditCard.unionpay' }
8
+ };
9
+
@@ -0,0 +1,9 @@
1
+ module.exports = {
2
+ cn: {
3
+ pattern: /^[1-9]\d{5}(18|19|20)\d{2}((0[1-9])|(1[0-2]))(([0-2][1-9])|10|20|30|31)\d{3}[0-9Xx]$/,
4
+ min: 18,
5
+ max: 18,
6
+ key: 'pattern.idCard.cn'
7
+ }
8
+ };
9
+
@@ -0,0 +1,8 @@
1
+ module.exports = {
2
+ phone: require('./phone'),
3
+ idCard: require('./idCard'),
4
+ creditCard: require('./creditCard'),
5
+ licensePlate: require('./licensePlate'),
6
+ postalCode: require('./postalCode'),
7
+ passport: require('./passport')
8
+ };
@@ -0,0 +1,4 @@
1
+ module.exports = {
2
+ cn: { pattern: /^[京津沪渝冀豫云辽黑湘皖鲁新苏浙赣鄂桂甘晋蒙陕吉闽贵粤青藏川宁琼使领][A-Z][A-HJ-NP-Z0-9]{4}[A-HJ-NP-Z0-9挂学警港澳]$/, key: 'pattern.licensePlate.cn' }
3
+ };
4
+
@@ -0,0 +1,4 @@
1
+ module.exports = {
2
+ cn: { pattern: /(^[EeKkGgDdHhMQqSs][0-9]{8}$)|(^(([Ee][a-fA-F])|([DdSPp][Ee])|([Kk][Jj])|([Mm][Aa])|(1[45]))[0-9]{7}$)/, key: 'pattern.passport.cn' }
3
+ };
4
+
@@ -0,0 +1,9 @@
1
+ module.exports = {
2
+ cn: { pattern: /^1[3-9]\d{9}$/, min: 11, max: 11, key: 'pattern.phone.cn' },
3
+ us: { pattern: /^\d{10}$/, min: 10, max: 10, key: 'pattern.phone.us' },
4
+ uk: { pattern: /^(\+44\s?)?0?\d{10}$/, min: 10, max: 15, key: 'pattern.phone.uk' },
5
+ hk: { pattern: /^[5-9]\d{7}$/, min: 8, max: 8, key: 'pattern.phone.hk' },
6
+ tw: { pattern: /^09\d{8}$/, min: 10, max: 10, key: 'pattern.phone.tw' },
7
+ international: { pattern: /^\+[1-9]\d{1,14}$/, min: 8, max: 15, key: 'pattern.phone.international' }
8
+ };
9
+
@@ -0,0 +1,5 @@
1
+ module.exports = {
2
+ cn: { pattern: /^[1-9]\d{5}$/, key: 'pattern.postalCode.cn' },
3
+ us: { pattern: /^\d{5}(-\d{4})?$/, key: 'pattern.postalCode.us' }
4
+ };
5
+