schema-dsl 1.1.3 → 1.1.5

package/lib/errors/I18nError.js

@@ -61,15 +61,34 @@ const MessageTemplate = require('../core/MessageTemplate');
 class I18nError extends Error {
   /**
    * 构造函数
-   * @param {string} code - 错误代码（多语言 key）
+   * @param {string} key - 错误代码（多语言 key）
    * @param {Object} params - 错误参数（用于插值）
    * @param {number} statusCode - HTTP 状态码（默认 400）
    * @param {string} locale - 语言环境（默认使用当前语言）
+   * @version 1.1.5 - 支持对象格式配置
    */
-  constructor(code, params = {}, statusCode = 400, locale = null) {
-    // 获取翻译后的消息模板
+  constructor(key, params = {}, statusCode = 400, locale = null) {
+    // 获取语言环境
     const actualLocale = locale || Locale.getLocale();
-    const template = Locale.getMessage(code, {}, actualLocale);
+
+    // 获取消息配置（v1.1.5: 返回对象 { code, message }）
+    const messageConfig = Locale.getMessage(key, {}, actualLocale);
+
+    // 判断返回类型（向后兼容）
+    let errorCode, template;
+    if (typeof messageConfig === 'object' && messageConfig.code && messageConfig.message) {
+      // 对象格式：提取 code 和 message
+      errorCode = messageConfig.code;
+      template = messageConfig.message;
+    } else if (typeof messageConfig === 'string') {
+      // 字符串格式（向后兼容）
+      errorCode = key;
+      template = messageConfig;
+    } else {
+      // 降级处理
+      errorCode = key;
+      template = key;
+    }
 
     // 使用 MessageTemplate 进行参数插值
     const messageTemplate = new MessageTemplate(template);
@@ -78,7 +97,8 @@ class I18nError extends Error {
     super(message);
 
     this.name = 'I18nError';
-    this.code = code;
+    this.originalKey = key;           // v1.1.5 新增：保留原始 key
+    this.code = errorCode;            // v1.1.5 修改：从对象提取或使用 key
     this.params = params || {};
     this.statusCode = statusCode;
     this.locale = actualLocale;
@@ -95,6 +115,7 @@ class I18nError extends Error {
    * @param {string} code - 错误代码（多语言 key）
    * @param {Object} params - 错误参数
    * @param {number} statusCode - HTTP 状态码
+   * @param {string} locale - 语言环境（可选，不传则使用全局语言）
    * @returns {I18nError} 错误实例
    *
    * @example
@@ -104,9 +125,13 @@ class I18nError extends Error {
    * @example
    * // 直接抛出
    * throw I18nError.create('error.notFound', { resource: '用户' });
+   *
+   * @example
+   * // 运行时指定语言
+   * const error = I18nError.create('error.notFound', {}, 404, 'en-US');
    */
-  static create(code, params = {}, statusCode = 400) {
-    return new I18nError(code, params, statusCode);
+  static create(code, params = {}, statusCode = 400, locale = null) {
+    return new I18nError(code, params, statusCode, locale);
   }
 
   /**
@@ -115,14 +140,19 @@ class I18nError extends Error {
    * @param {string} code - 错误代码（多语言 key）
    * @param {Object} params - 错误参数
    * @param {number} statusCode - HTTP 状态码
+   * @param {string} locale - 语言环境（可选，不传则使用全局语言）
    * @throws {I18nError} 直接抛出错误
    *
    * @example
    * I18nError.throw('error.notFound', { resource: '用户' });
    * // 等同于：throw I18nError.create('error.notFound', { resource: '用户' });
+   *
+   * @example
+   * // 运行时指定语言
+   * I18nError.throw('error.notFound', {}, 404, 'en-US');
    */
-  static throw(code, params = {}, statusCode = 400) {
-    throw new I18nError(code, params, statusCode);
+  static throw(code, params = {}, statusCode = 400, locale = null) {
+    throw new I18nError(code, params, statusCode, locale);
   }
 
   /**
@@ -132,6 +162,7 @@ class I18nError extends Error {
    * @param {string} code - 错误代码（多语言 key）
    * @param {Object} params - 错误参数
    * @param {number} statusCode - HTTP 状态码
+   * @param {string} locale - 语言环境（可选，不传则使用全局语言）
    * @throws {I18nError} 条件为 false 时抛出错误
    *
    * @example
@@ -144,17 +175,21 @@ class I18nError extends Error {
    *   'account.insufficientBalance',
    *   { balance: account.balance, required: 100 }
    * );
+   *
+   * @example
+   * // 运行时指定语言
+   * I18nError.assert(account, 'account.notFound', {}, 404, 'en-US');
    */
-  static assert(condition, code, params = {}, statusCode = 400) {
+  static assert(condition, code, params = {}, statusCode = 400, locale = null) {
     if (!condition) {
-      throw new I18nError(code, params, statusCode);
+      throw new I18nError(code, params, statusCode, locale);
     }
   }
 
   /**
    * 检查错误是否为指定代码
    *
-   * @param {string} code - 错误代码
+   * @param {string} codeOrKey - 错误代码或原始 key
    * @returns {boolean} 是否匹配
    *
    * @example
@@ -164,10 +199,16 @@ class I18nError extends Error {
    *   if (error instanceof I18nError && error.is('account.notFound')) {
    *     // 处理账户不存在的情况
    *   }
+   *
+   *   // v1.1.5: 也可以用 code 判断
+   *   if (error instanceof I18nError && error.is('ACCOUNT_NOT_FOUND')) {
+   *     // 也能匹配
+   *   }
    * }
    */
-  is(code) {
-    return this.code === code;
+  is(codeOrKey) {
+    // v1.1.5: 同时比较 code 和 originalKey（向后兼容）
+    return this.code === codeOrKey || this.originalKey === codeOrKey;
   }
 
   /**
@@ -175,6 +216,7 @@ class I18nError extends Error {
    *
    * @returns {Object} JSON 对象
    * @returns {string} return.error - 错误名称
+   * @returns {string} return.originalKey - 原始 key（v1.1.5 新增）
    * @returns {string} return.code - 错误代码
    * @returns {string} return.message - 错误消息（已翻译）
    * @returns {Object} return.params - 错误参数
@@ -186,7 +228,8 @@ class I18nError extends Error {
    * res.status(error.statusCode).json(json);
    * // {
    * //   error: 'I18nError',
-   * //   code: 'account.notFound',
+   * //   originalKey: 'account.notFound',  // v1.1.5 新增
+   * //   code: 'ACCOUNT_NOT_FOUND',
    * //   message: '找不到账户',
    * //   params: { accountId: '123' },
    * //   statusCode: 404,
@@ -196,6 +239,7 @@ class I18nError extends Error {
   toJSON() {
     return {
       error: this.name,
+      originalKey: this.originalKey,  // v1.1.5 新增
       code: this.code,
       message: this.message,
       params: this.params,

package/lib/locales/en-US.js

@@ -26,10 +26,17 @@ module.exports = {
   'error.conflict': 'Operation conflict: {{#reason}}',
 
   // I18nError - Account related (v1.1.1)
-  'account.notFound': 'Account not found',
+  // v1.1.5: Using object format for some examples
+  'account.notFound': {
+    code: 'ACCOUNT_NOT_FOUND',
+    message: 'Account not found'
+  },
   'account.inactive': 'Account is inactive',
   'account.banned': 'Account has been banned',
-  'account.insufficientBalance': 'Insufficient balance, current: {{#balance}}, required: {{#required}}',
+  'account.insufficientBalance': {
+    code: 'INSUFFICIENT_BALANCE',
+    message: 'Insufficient balance, current: {{#balance}}, required: {{#required}}'
+  },
   'account.insufficientCredits': 'Insufficient credits, current: {{#credits}}, required: {{#required}}',
 
   // I18nError - User related (v1.1.1)
@@ -38,7 +45,10 @@ module.exports = {
   'user.noPermission': 'No admin permission',
 
   // I18nError - Order related (v1.1.1)
-  'order.notPaid': 'Order not paid',
+  'order.notPaid': {
+    code: 'ORDER_NOT_PAID',
+    message: 'Order not paid'
+  },
   'order.paymentMissing': 'Payment information missing',
   'order.addressMissing': 'Shipping address missing',
 

package/lib/locales/zh-CN.js

@@ -17,6 +17,7 @@ module.exports = {
   'conditional.blocked': '账号已被封禁',
   'conditional.notAllowed': '不允许注册',
 
+  // I18nError - 通用错误消息 (v1.1.1)
   // I18nError - 通用错误消息 (v1.1.1)
   'error.notFound': '找不到{{#resource}}',
   'error.forbidden': '没有权限访问{{#resource}}',
@@ -26,10 +27,17 @@ module.exports = {
   'error.conflict': '操作冲突: {{#reason}}',
 
   // I18nError - 账户相关 (v1.1.1)
-  'account.notFound': '账户不存在',
+  // v1.1.5: 部分使用对象格式示例
+  'account.notFound': {
+    code: 'ACCOUNT_NOT_FOUND',
+    message: '账户不存在'
+  },
   'account.inactive': '账户未激活',
   'account.banned': '账户已被封禁',
-  'account.insufficientBalance': '余额不足，当前余额{{#balance}}，需要{{#required}}',
+  'account.insufficientBalance': {
+    code: 'INSUFFICIENT_BALANCE',
+    message: '余额不足，当前余额{{#balance}}，需要{{#required}}'
+  },
   'account.insufficientCredits': '积分不足，当前积分{{#credits}}，需要{{#required}}',
 
   // I18nError - 用户相关 (v1.1.1)
@@ -38,7 +46,10 @@ module.exports = {
   'user.noPermission': '没有管理员权限',
 
   // I18nError - 订单相关 (v1.1.1)
-  'order.notPaid': '订单未支付',
+  'order.notPaid': {
+    code: 'ORDER_NOT_PAID',
+    message: '订单未支付'
+  },
   'order.paymentMissing': '缺少支付信息',
   'order.addressMissing': '缺少收货地址',
 

package/lib/validators/CustomKeywords.js

@@ -90,12 +90,20 @@ class CustomKeywords {
               // ajv 默认不支持同步验证中的异步操作
               // 这里我们只能抛出错误提示
               // 真正的异步支持需要 Validator.validateAsync
-              throw new Error(Locale.getMessage('ASYNC_VALIDATION_NOT_SUPPORTED'));
+              const messageConfig = Locale.getMessage('ASYNC_VALIDATION_NOT_SUPPORTED');
+              const errorMessage = typeof messageConfig === 'object' && messageConfig.message
+                ? messageConfig.message
+                : messageConfig;
+              throw new Error(errorMessage);
             }
 
             // 处理返回值
             if (result === false) {
-              validate.errors = [{ message: Locale.getMessage('CUSTOM_VALIDATION_FAILED') }];
+              const messageConfig = Locale.getMessage('CUSTOM_VALIDATION_FAILED');
+              const errorMessage = typeof messageConfig === 'object' && messageConfig.message
+                ? messageConfig.message
+                : messageConfig;
+              validate.errors = [{ message: errorMessage }];
               return false;
             }
             if (typeof result === 'string') {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "schema-dsl",
-  "version": "1.1.3",
+  "version": "1.1.5",
   "description": "简洁强大的JSON Schema验证库 - DSL语法 + String扩展 + 便捷validate",
   "main": "index.js",
   "types": "index.d.ts",