schema-dsl 1.2.5 → 2.0.1

package/changelogs/v1.0.0.md

@@ -1,328 +0,0 @@
-# v1.0.0 变更日志
-
-> **发布日期**: 2025-12-29  
-> **版本号**: v1.0.0  
-> **类型**: 🎉 正式发布
-
----
-
-## 📋 变更概览
-
-这是 schema-dsl 的首个正式发布版本，标志着项目达到生产就绪状态。
-
-| 里程碑 | 状态 |
-|--------|------|
-| 核心功能完善 | ✅ |
-| 测试覆盖充分 | ✅ |
-| 文档完整 | ✅ |
-| npm 发布 | ✅ |
-| 生产就绪 | ✅ |
-
----
-
-## 🎉 核心特性
-
-### 1. 极简 DSL 语法
-
-**一行代码定义验证规则，代码量减少 65%**
-
-```javascript
-const { dsl } = require('schema-dsl');
-
-// ✅ 简洁的 DSL 语法
-const schema = dsl({
-  username: 'string:3-32!',
-  email: 'email!',
-  age: 'number:18-120',
-  tags: 'array<string>'
-});
-
-// ❌ 对比 Joi（需要 8 行）
-const Joi = require('joi');
-const joiSchema = Joi.object({
-  username: Joi.string().min(3).max(32).required(),
-  email: Joi.string().email().required(),
-  age: Joi.number().min(18).max(120),
-  tags: Joi.array().items(Joi.string())
-});
-```
-
----
-
-### 2. 完整的验证功能
-
-#### 基础类型
-
-- ✅ `string` - 字符串验证
-- ✅ `number` - 数字验证
-- ✅ `integer` - 整数验证
-- ✅ `boolean` - 布尔值验证
-- ✅ `date` / `datetime` - 日期时间验证
-- ✅ `email` - 邮箱验证
-- ✅ `url` - URL验证
-- ✅ `phone` - 手机号验证
-- ✅ `idCard` - 身份证验证
-
-#### 高级功能
-
-- ✅ **嵌套对象验证**
-- ✅ **数组验证**
-- ✅ **正则表达式验证**
-- ✅ **自定义验证器**
-- ✅ **条件验证**
-- ✅ **枚举验证**
-
----
-
-### 3. 高性能设计
-
-**性能测试结果**：
-
-| 验证库 | 性能 (ops/s) | 相对速度 |
-|--------|-------------|---------|
-| **schema-dsl** | **2,879,606** | **基准 (1.00x)** |
-| Zod | 1,818,592 | 0.63x (慢 58%) |
-| Joi | 299,761 | 0.10x (慢 861%) |
-| Yup | 106,378 | 0.04x (慢 2607%) |
-
-**优化技术**：
-- ✅ WeakMap 缓存机制
-- ✅ 智能编译优化
-- ✅ 批量验证优化
-- ✅ 惰性求值
-
----
-
-### 4. TypeScript 完整支持
-
-```typescript
-import { dsl, validate, ValidationError } from 'schema-dsl';
-
-// 完整的类型推导
-const schema = dsl({
-  username: 'string:3-32!',
-  email: 'email!'
-});
-
-// 类型安全的验证
-const result = validate(schema, data);
-
-if (result.valid) {
-  console.log(result.data);  // 类型推导
-} else {
-  console.log(result.errors); // ValidationError[]
-}
-```
-
----
-
-### 5. 数据库 Schema 导出
-
-**独家功能：从验证规则直接生成数据库结构**
-
-```javascript
-const { dsl, exporters } = require('schema-dsl');
-
-const schema = dsl({
-  username: 'string:3-32!',
-  email: 'email!',
-  age: 'number:18-120'
-});
-
-// MongoDB Schema
-const mongoExporter = new exporters.MongoDBExporter();
-const mongoSchema = mongoExporter.export(schema);
-
-// MySQL DDL
-const mysqlExporter = new exporters.MySQLExporter();
-const mysqlDDL = mysqlExporter.export('users', schema);
-
-// PostgreSQL DDL
-const pgExporter = new exporters.PostgreSQLExporter();
-const pgDDL = pgExporter.export('users', schema);
-```
-
----
-
-### 6. 框架集成
-
-**Express**
-```javascript
-const { validateAsync, ValidationError } = require('schema-dsl');
-
-app.post('/api/users', async (req, res, next) => {
-  try {
-    const validData = await validateAsync(userSchema, req.body);
-    // 验证通过...
-  } catch (error) {
-    next(error);
-  }
-});
-```
-
-**Koa**
-```javascript
-app.use(async (ctx, next) => {
-  try {
-    ctx.validData = await validateAsync(schema, ctx.request.body);
-    await next();
-  } catch (error) {
-    if (error instanceof ValidationError) {
-      ctx.status = 400;
-      ctx.body = { errors: error.errors };
-    }
-  }
-});
-```
-
----
-
-### 7. 条件验证
-
-```javascript
-const { dsl } = require('schema-dsl');
-
-// 快速断言
-dsl.if(d => d.age < 18)
-  .message('未成年用户不能注册')
-  .assert(userData);
-
-// 复杂条件
-dsl.if(d => d.role === 'admin')
-  .and(d => d.permissions.includes('delete'))
-  .message('权限不足')
-  .assert(user);
-```
-
----
-
-### 8. Schema 复用工具
-
-```javascript
-const { SchemaUtils } = require('schema-dsl');
-
-// 选择字段
-const createSchema = SchemaUtils.pick(fullSchema, ['username', 'email']);
-
-// 排除字段
-const publicSchema = SchemaUtils.omit(fullSchema, ['password']);
-
-// 变为可选
-const updateSchema = SchemaUtils.partial(createSchema);
-
-// 扩展字段
-const registerSchema = createSchema.extend({
-  captcha: 'string:4-6!',
-  agree: 'boolean!'
-});
-```
-
----
-
-## 📚 完整文档
-
-### 用户指南
-
-- ✅ [快速开始](../README.md#快速开始)
-- ✅ [DSL 语法](../docs/dsl-syntax.md)
-- ✅ [验证指南](../docs/validation-guide.md)
-- ✅ [类型参考](../docs/type-reference.md)
-
-### API 文档
-
-- ✅ [dsl() API](../docs/api-reference.md)
-- ✅ [validate() API](../docs/validate.md)
-- ✅ [validateAsync() API](../docs/validate-async.md)
-- ✅ [SchemaUtils API](../docs/schema-utils.md)
-
-### 高级功能
-
-- ✅ [条件验证](../docs/conditional-api.md)
-- ✅ [自定义扩展](../docs/custom-extensions-guide.md)
-- ✅ [数据库导出](../docs/mongodb-exporter.md)
-- ✅ [性能优化](../docs/cache-manager.md)
-
-### 框架集成
-
-- ✅ [Express 集成](../examples/express-integration.js)
-- ✅ [Koa 集成](../examples/middleware-usage.js)
-- ✅ [Fastify 集成](../examples/middleware-usage.js)
-
----
-
-## 📊 测试覆盖
-
-- ✅ **测试套件**: 800+ 个测试用例
-- ✅ **测试覆盖率**: 95%+
-- ✅ **兼容性测试**: Node.js 14/16/18/20
-
----
-
-## 🎯 生产就绪
-
-### 质量保证
-
-- ✅ 所有测试通过
-- ✅ 无已知严重 Bug
-- ✅ 文档完整
-- ✅ API 稳定
-
-### 性能验证
-
-- ✅ 基准测试完成
-- ✅ 性能优于主流验证库
-- ✅ 内存占用合理
-
-### 安全性
-
-- ✅ 无已知安全漏洞
-- ✅ 输入验证严格
-- ✅ 错误处理完善
-
----
-
-## 📦 npm 发布
-
-```bash
-npm install schema-dsl
-```
-
-**包信息**：
-- 包名: `schema-dsl`
-- 版本: `1.0.0`
-- 大小: ~50KB (未压缩)
-- 许可证: MIT
-
----
-
-## 🎉 里程碑
-
-v1.0.0 标志着 schema-dsl 的以下成就：
-
-1. ✅ **功能完整**: 覆盖所有常见验证场景
-2. ✅ **性能优秀**: 超越主流验证库
-3. ✅ **文档完善**: 40+ 篇详细文档
-4. ✅ **测试充分**: 800+ 测试用例
-5. ✅ **生产就绪**: 可用于生产环境
-
----
-
-## 🙏 致谢
-
-感谢所有测试用户和贡献者的反馈，让 schema-dsl 达到了生产就绪的质量标准。
-
----
-
-## 🔗 相关链接
-
-- [GitHub Repository](https://github.com/vextjs/schema-dsl)
-- [npm Package](https://www.npmjs.com/package/schema-dsl)
-- [完整文档](../docs/INDEX.md)
-- [在线体验](https://runkit.com/npm/schema-dsl)
-
----
-
-**发布者**: schema-dsl Team  
-**发布时间**: 2025-12-29  
-**下一版本**: v1.0.1
-

package/changelogs/v1.0.9.md

@@ -1,367 +0,0 @@
-# v1.0.9 变更日志
-
-> **发布日期**: 2026-01-04  
-> **版本号**: v1.0.9  
-> **类型**: 🎉 重大改进
-
----
-
-## 📋 变更概览
-
-| 类型 | 数量 | 说明 |
-|------|------|------|
-| 🎉 新功能 | 2 | 完整多语言支持、I18nError类 |
-| ⚡ 功能增强 | 1 | TypeScript类型定义完善 |
-| 📚 文档更新 | 5 | 多语言相关文档 |
-
----
-
-## 🎉 新功能
-
-### 1. 完整的多语言支持
-
-**内置5种语言，开箱即用的国际化方案**
-
-#### 支持的语言
-
-| 语言代码 | 语言名称 | 完整度 | 说明 |
-|---------|---------|--------|------|
-| zh-CN | 简体中文 | 100% | 默认语言 |
-| en-US | 英文（美国） | 100% | 完整翻译 |
-| ja-JP | 日语 | 95% | 主要功能已翻译 |
-| es-ES | 西班牙语 | 90% | 核心功能已翻译 |
-| fr-FR | 法语 | 90% | 核心功能已翻译 |
-
-#### 快速配置
-
-**方式1：使用内置语言**
-
-```javascript
-const { dsl, validate, Locale } = require('schema-dsl');
-
-// 设置全局语言
-Locale.setLocale('zh-CN');
-
-const schema = dsl({ username: 'string:3-32!' });
-
-// 中文错误消息
-const result = validate(schema, { username: 'ab' });
-console.log(result.errors[0].message);
-// => "username长度不能少于3个字符"
-```
-
-**方式2：配置自定义语言包目录**
-
-```javascript
-const path = require('path');
-
-// 应用启动时配置一次
-dsl.config({
-  i18n: path.join(__dirname, 'locales')
-});
-
-// 自动加载目录下所有语言文件
-// locales/zh-CN.js
-// locales/en-US.js
-// locales/custom-lang.js
-```
-
-#### 自定义语言包
-
-```javascript
-// locales/zh-CN.js
-module.exports = {
-  'required': '{{#path}} 是必填项',
-  'string.min': '{{#path}} 长度不能少于 {{#min}} 个字符',
-  'string.max': '{{#path}} 长度不能超过 {{#max}} 个字符',
-  'email': '{{#path}} 必须是有效的邮箱地址',
-  'account.notFound': '账户不存在',
-  'account.insufficientBalance': '余额不足，当前余额{{balance}}，需要{{required}}'
-};
-
-// locales/en-US.js
-module.exports = {
-  'required': '{{#path}} is required',
-  'string.min': '{{#path}} must be at least {{#min}} characters',
-  'string.max': '{{#path}} must not exceed {{#max}} characters',
-  'email': '{{#path}} must be a valid email',
-  'account.notFound': 'Account not found',
-  'account.insufficientBalance': 'Insufficient balance, current: {{balance}}, required: {{required}}'
-};
-```
-
-#### 运行时切换语言
-
-```javascript
-// 全局切换
-Locale.setLocale('en-US');
-
-// 验证时指定语言
-validate(schema, data, { locale: 'ja-JP' });
-
-// 获取当前语言
-const currentLocale = Locale.getLocale();  // 'en-US'
-```
-
-#### 参数插值
-
-```javascript
-// 自动插值
-const schema = dsl({ age: 'number:18-120!' });
-validate(schema, { age: 15 });
-// => "age must be at least 18" (en-US)
-// => "age 必须至少为 18" (zh-CN)
-
-// 自定义参数插值
-const error = new I18nError('account.insufficientBalance', {
-  balance: 50,
-  required: 100
-});
-console.log(error.message);
-// => "余额不足，当前余额50，需要100" (zh-CN)
-// => "Insufficient balance, current: 50, required: 100" (en-US)
-```
-
----
-
-### 2. I18nError 多语言错误类
-
-**统一的多语言错误处理类**
-
-#### 基础用法
-
-```javascript
-const { I18nError } = require('schema-dsl');
-
-// 创建错误
-const error = new I18nError(
-  'account.notFound',  // 错误代码
-  {},                  // 参数（可选）
-  404                  // HTTP状态码（可选）
-);
-
-console.log(error.code);        // 'account.notFound'
-console.log(error.message);     // '账户不存在' (zh-CN)
-console.log(error.statusCode);  // 404
-```
-
-#### 静态方法
-
-```javascript
-// 直接抛出错误
-I18nError.throw('user.noPermission');
-
-// 断言风格
-I18nError.assert(user, 'user.notFound');
-I18nError.assert(
-  user.role === 'admin',
-  'user.noPermission'
-);
-
-// 创建错误对象
-const error = I18nError.create('account.notFound', {}, 404);
-```
-
-#### 错误对象属性
-
-```javascript
-const error = new I18nError('account.insufficientBalance', {
-  balance: 50,
-  required: 100
-}, 400);
-
-console.log(error.code);        // 'account.insufficientBalance'
-console.log(error.message);     // '余额不足，当前余额50，需要100'
-console.log(error.statusCode);  // 400
-console.log(error.params);      // { balance: 50, required: 100 }
-
-// JSON序列化
-console.log(error.toJSON());
-// {
-//   code: 'account.insufficientBalance',
-//   message: '余额不足，当前余额50，需要100',
-//   statusCode: 400,
-//   params: { balance: 50, required: 100 }
-// }
-```
-
-#### Express/Koa 集成
-
-```javascript
-// Express 错误处理中间件
-app.use((error, req, res, next) => {
-  if (error instanceof I18nError) {
-    return res.status(error.statusCode).json({
-      success: false,
-      code: error.code,
-      message: error.message,
-      params: error.params
-    });
-  }
-  next(error);
-});
-
-// 业务代码
-app.post('/api/withdraw', async (req, res, next) => {
-  try {
-    const account = await getAccount(req.user.id);
-    I18nError.assert(account, 'account.notFound', {}, 404);
-    
-    I18nError.assert(
-      account.balance >= req.body.amount,
-      'account.insufficientBalance',
-      { balance: account.balance, required: req.body.amount },
-      400
-    );
-    
-    // 处理提现...
-    res.json({ success: true });
-  } catch (error) {
-    next(error);
-  }
-});
-```
-
----
-
-## ⚡ 功能增强
-
-### TypeScript 类型定义完善
-
-**完整的类型定义，100% 类型安全**
-
-#### 新增类型
-
-```typescript
-// Locale 类型
-interface Locale {
-  setLocale(locale: string): void;
-  getLocale(): string;
-  getMessage(code: string, params?: Record<string, any>): string;
-  setMessages(messages: Record<string, string>): void;
-}
-
-// I18nError 类型
-class I18nError extends Error {
-  code: string;
-  statusCode: number;
-  params: Record<string, any>;
-  
-  constructor(
-    code: string,
-    params?: Record<string, any>,
-    statusCode?: number
-  );
-  
-  static throw(code: string, params?: Record<string, any>, statusCode?: number): never;
-  static assert(condition: any, code: string, params?: Record<string, any>, statusCode?: number): asserts condition;
-  static create(code: string, params?: Record<string, any>, statusCode?: number): I18nError;
-  
-  toJSON(): object;
-  is(code: string): boolean;
-}
-
-// ValidationOptions 扩展
-interface ValidationOptions {
-  locale?: string;  // 新增：验证时指定语言
-  // ...其他选项
-}
-```
-
-#### 使用示例
-
-```typescript
-import { dsl, validate, I18nError, Locale } from 'schema-dsl';
-
-// 完整的类型推导
-const schema = dsl({ email: 'email!' });
-
-// 验证时指定语言
-const result = validate(schema, data, { locale: 'en-US' });
-
-// I18nError 类型安全
-try {
-  I18nError.throw('account.notFound', {}, 404);
-} catch (error) {
-  if (error instanceof I18nError) {
-    console.log(error.code);        // string
-    console.log(error.statusCode);  // number
-    console.log(error.params);      // Record<string, any>
-  }
-}
-```
-
----
-
-## 📚 文档更新
-
-1. ✅ **多语言用户指南**: [docs/i18n-user-guide.md](../docs/i18n-user-guide.md)
-2. ✅ **I18n 完整文档**: [docs/i18n.md](../docs/i18n.md)
-3. ✅ **I18nError API 文档**: [docs/error-handling.md](../docs/error-handling.md)
-4. ✅ **自定义语言包指南**: [docs/add-custom-locale.md](../docs/add-custom-locale.md)
-5. ✅ **前端 i18n 集成**: [docs/frontend-i18n-guide.md](../docs/frontend-i18n-guide.md)
-
----
-
-## 🔄 破坏性变更
-
-**无破坏性变更** - 所有新功能都是可选的，默认行为保持不变。
-
----
-
-## 🎯 升级指南
-
-### 从 v1.0.8 升级到 v1.0.9
-
-```bash
-npm install schema-dsl@1.0.9
-```
-
-**可选：启用多语言**
-
-```javascript
-const { Locale } = require('schema-dsl');
-
-// 设置全局语言（可选）
-Locale.setLocale('zh-CN');
-
-// 或在验证时指定（可选）
-validate(schema, data, { locale: 'en-US' });
-```
-
-**可选：使用 I18nError**
-
-```javascript
-const { I18nError } = require('schema-dsl');
-
-// 替代普通 Error
-I18nError.throw('account.notFound');
-```
-
----
-
-## 📦 依赖变更
-
-**无依赖变更**
-
----
-
-## 🙏 致谢
-
-感谢社区贡献者提供的多语言翻译和反馈。
-
----
-
-## 🔗 相关链接
-
-- [GitHub Repository](https://github.com/vextjs/schema-dsl)
-- [npm Package](https://www.npmjs.com/package/schema-dsl)
-- [完整多语言文档](../docs/i18n.md)
-- [I18nError 示例](../examples/i18n-error.examples.js)
-
----
-
-**发布者**: schema-dsl Team  
-**发布时间**: 2026-01-04  
-**下一版本**: v1.1.0
-