schema-dsl 1.2.5 → 2.0.1

package/index.js

@@ -1,475 +0,0 @@
-/**
- * schema-dsl - 主入口文件
- *
- * 统一的DSL Builder Pattern
- * 简洁 + 强大 = 完美平衡
- *
- * @module schema-dsl
- * @version 1.0.4
- */
-
-// ========== 核心层 ==========
-const JSONSchemaCore = require("./lib/core/JSONSchemaCore");
-const Validator = require("./lib/core/Validator");
-const ErrorFormatter = require("./lib/core/ErrorFormatter");
-const CacheManager = require("./lib/core/CacheManager");
-const DslBuilder = require("./lib/core/DslBuilder");
-const PluginManager = require("./lib/core/PluginManager");
-const ConditionalBuilder = require("./lib/core/ConditionalBuilder");
-
-// ========== 错误消息系统 ==========
-const ErrorCodes = require("./lib/core/ErrorCodes");
-const MessageTemplate = require("./lib/core/MessageTemplate");
-const Locale = require("./lib/core/Locale");
-
-// ========== 错误类 ==========
-const ValidationError = require("./lib/errors/ValidationError");
-const I18nError = require("./lib/errors/I18nError");
-
-// ========== String 扩展 ==========
-const {
-  installStringExtensions,
-  uninstallStringExtensions,
-} = require("./lib/core/StringExtensions");
-
-// ========== 适配器层 ==========
-const dsl = require("./lib/adapters/DslAdapter");
-
-// 挂载静态方法 (v2.1.0)
-dsl.match = dsl.DslAdapter.match;
-
-// ✅ 智能 dsl.if：根据参数类型选择实现
-dsl.if = function (...args) {
-  // 如果第一个参数是函数 → 使用新的 ConditionalBuilder（链式API）
-  if (typeof args[0] === "function") {
-    return ConditionalBuilder.start(args[0]);
-  }
-
-  // 如果第一个参数是字符串且有3个参数 → 使用原有的字段条件实现
-  // dsl.if('fieldName', thenSchema, elseSchema)
-  if (typeof args[0] === "string" && args.length >= 2) {
-    return dsl.DslAdapter.if(args[0], args[1], args[2]);
-  }
-
-  // 其他情况 → 调用 ConditionalBuilder 让它抛出正确的错误
-  return ConditionalBuilder.start(args[0]);
-};
-
-// ✅ dsl.error：统一的多语言错误抛出（v1.1.1+）
-// v1.1.8: 支持简化语法，智能参数识别
-dsl.error = {
-  /**
-   * 创建多语言错误（不抛出）
-   * @param {string} code - 错误代码（多语言 key）
-   * @param {Object|string} paramsOrLocale - 错误参数对象 或 语言代码（智能识别）
-   * @param {number} statusCode - HTTP 状态码
-   * @param {string} locale - 语言环境（仅当第2个参数是对象时有效）
-   * @returns {I18nError} 错误实例
-   *
-   * @example
-   * // 简化语法
-   * dsl.error.create('account.notFound', 'zh-CN');
-   *
-   * @example
-   * // 标准语法
-   * dsl.error.create('account.notFound', { id: '123' }, 404, 'zh-CN');
-   */
-  create: (code, paramsOrLocale, statusCode, locale) =>
-    I18nError.create(code, paramsOrLocale, statusCode, locale),
-
-  /**
-   * 抛出多语言错误
-   * @param {string} code - 错误代码（多语言 key）
-   * @param {Object|string} paramsOrLocale - 错误参数对象 或 语言代码（智能识别）
-   * @param {number} statusCode - HTTP 状态码
-   * @param {string} locale - 语言环境（仅当第2个参数是对象时有效）
-   * @throws {I18nError} 直接抛出错误
-   *
-   * @example
-   * // 简化语法
-   * dsl.error.throw('account.notFound', 'zh-CN');
-   *
-   * @example
-   * // 标准语法
-   * dsl.error.throw('account.notFound', { id: '123' }, 404, 'zh-CN');
-   */
-  throw: (code, paramsOrLocale, statusCode, locale) =>
-    I18nError.throw(code, paramsOrLocale, statusCode, locale),
-
-  /**
-   * 断言方法 - 条件不满足时抛错
-   * @param {boolean} condition - 条件表达式
-   * @param {string} code - 错误代码（多语言 key）
-   * @param {Object|string} paramsOrLocale - 错误参数对象 或 语言代码（智能识别）
-   * @param {number} statusCode - HTTP 状态码
-   * @param {string} locale - 语言环境（仅当第3个参数是对象时有效）
-   *
-   * @example
-   * // 简化语法
-   * dsl.error.assert(account, 'account.notFound', 'zh-CN');
-   *
-   * @example
-   * // 标准语法
-   * dsl.error.assert(account, 'account.notFound', { id: '123' }, 404, 'zh-CN');
-   */
-  assert: (condition, code, paramsOrLocale, statusCode, locale) =>
-    I18nError.assert(condition, code, paramsOrLocale, statusCode, locale),
-};
-
-/**
- * 从目录递归加载语言包（内部函数）
- *
- * 支持子目录递归扫描，子目录名作为模块组织层（不影响语言 key）。
- * 同名 key 冲突时：strict 模式抛错，默认模式打 WARN 日志。
- *
- * @param {string} dirPath - 目录绝对路径
- * @param {Object} options - 配置选项
- * @param {boolean} [options.strict=false] - 严格模式：同名 key 冲突时抛出 Error
- * @private
- */
-function loadLocalesFromDir(dirPath, options = {}) {
-  const fs = require("fs");
-  const path = require("path");
-
-  if (!fs.existsSync(dirPath) || !fs.statSync(dirPath).isDirectory()) {
-    console.warn(
-      "[schema-dsl] i18n path does not exist or is not a directory:",
-      dirPath,
-    );
-    return;
-  }
-
-  // 语言代码格式校验：zh-CN / en-US / zh / en 等
-  const LOCALE_NAME_RE = /^[a-z]{2,3}(-[A-Z]{2,4})?$/;
-
-  const entries = fs.readdirSync(dirPath, { withFileTypes: true });
-
-  entries.forEach((entry) => {
-    const fullPath = path.join(dirPath, entry.name);
-
-    if (entry.isDirectory()) {
-      // 递归进入子目录（子目录名仅作模块组织层，不影响语言 key）
-      loadLocalesFromDir(fullPath, options);
-    } else if (entry.isFile()) {
-      const ext = path.extname(entry.name);
-      if (ext !== ".js" && ext !== ".cjs" && ext !== ".json") return;
-
-      const localeName = path.basename(entry.name, ext);
-
-      // 文件名格式校验：只加载符合语言代码格式的文件
-      if (!LOCALE_NAME_RE.test(localeName)) {
-        // 仅 debug 级别，不影响正常运行
-        return;
-      }
-
-      let messages;
-      try {
-        messages = require(path.resolve(fullPath));
-      } catch (e) {
-        console.warn(
-          "[schema-dsl] Failed to load locale file:",
-          fullPath,
-          e.message,
-        );
-        return;
-      }
-
-      // 冲突检测：检查 messages 的每个 key 是否已存在于当前语言包
-      const existing = Locale.locales[localeName] || {};
-      const conflictKeys = Object.keys(messages).filter((k) =>
-        Object.prototype.hasOwnProperty.call(existing, k),
-      );
-
-      if (conflictKeys.length > 0) {
-        const keyList = conflictKeys.join(", ");
-        const msg = `[schema-dsl] i18n key 冲突 in locale '${localeName}'\n  冲突 key: ${keyList}\n  来源文件: ${fullPath}`;
-        if (options.strict) {
-          throw new Error(msg);
-        } else {
-          console.warn(msg);
-        }
-      }
-
-      Locale.addLocale(localeName, messages);
-    }
-  });
-}
-
-/**
- * 全局配置
- * @param {Object} options - 配置选项
- * @param {Object} options.patterns - 验证规则扩展 (phone, idCard, creditCard)
- * @param {string|Object} options.i18n - 多语言配置（目录路径、对象语言包、或含 localesPath 的对象）
- * @param {Object} options.cache - 缓存配置
- * @param {boolean} [options.strict=false] - 严格模式：i18n 目录扫描时 key 冲突直接抛错（默认 false）
- */
-dsl.config = function (options = {}) {
-  const patterns = require("./lib/config/patterns");
-
-  // patterns 配置
-  if (options.patterns) {
-    if (options.patterns.phone)
-      Object.assign(patterns.phone, options.patterns.phone);
-    if (options.patterns.idCard)
-      Object.assign(patterns.idCard, options.patterns.idCard);
-    if (options.patterns.creditCard)
-      Object.assign(patterns.creditCard, options.patterns.creditCard);
-  }
-
-  // 多语言支持 (v1.0.1 优化；v1.2.3 增强：递归子目录 + 冲突检测)
-  if (options.i18n) {
-    // 方式 1: 传入目录路径（字符串）→ 递归扫描
-    if (typeof options.i18n === "string") {
-      loadLocalesFromDir(options.i18n, options);
-    }
-    // 方式 2: 传入对象
-    else if (typeof options.i18n === "object") {
-      // 方式 2a: 含 localesPath 字段 → 走目录扫描（兼容文档记载用法）
-      if (options.i18n.localesPath) {
-        loadLocalesFromDir(options.i18n.localesPath, options);
-      }
-      // 方式 2b: 直接传语言包对象 { 'zh-CN': {...}, 'en-US': {...} }（原有逻辑，不变）
-      else {
-        Object.keys(options.i18n).forEach((locale) => {
-          Locale.addLocale(locale, options.i18n[locale]);
-        });
-      }
-    }
-  }
-
-  // 缓存配置 (v1.0.4+)
-  if (options.cache) {
-    // 如果 Validator 还未创建，保存配置供后续创建时使用
-    if (!_defaultValidator) {
-      _validatorOptions.cache = options.cache;
-    } else {
-      // 如果已创建，动态修改现有实例的配置（向后兼容）
-      const cacheOpts = _defaultValidator.cache.options;
-      if (options.cache.maxSize !== undefined) {
-        cacheOpts.maxSize = options.cache.maxSize;
-      }
-      if (options.cache.ttl !== undefined) {
-        cacheOpts.ttl = options.cache.ttl;
-      }
-      if (options.cache.enabled !== undefined) {
-        cacheOpts.enabled = options.cache.enabled;
-      }
-      if (options.cache.statsEnabled !== undefined) {
-        cacheOpts.statsEnabled = options.cache.statsEnabled;
-      }
-    }
-  }
-};
-
-// ========== 导出器层 ==========
-const exporters = require("./lib/exporters");
-
-// ========== 初始化默认语言包 ==========
-const defaultLocales = require("./lib/locales");
-Object.entries(defaultLocales).forEach(([locale, messages]) => {
-  Locale.addLocale(locale, messages);
-});
-
-// ========== 单例Validator ==========
-let _defaultValidator = null;
-let _validatorOptions = {}; // 存储 Validator 配置选项
-
-/**
- * 获取默认Validator实例（单例）
- * @returns {Validator}
- */
-function getDefaultValidator() {
-  if (!_defaultValidator) {
-    _defaultValidator = new Validator(_validatorOptions);
-  }
-  return _defaultValidator;
-}
-
-/**
- * 智能类型转换：只转换字符串→数字（当schema要求number且能转换时）
- * @private
- * @param {*} data - 原始数据
- * @param {Object} schema - JSON Schema对象
- * @returns {*} 转换后的数据
- */
-function smartCoerceTypes(data, schema) {
-  if (!data || typeof data !== "object") return data;
-
-  // 获取 schema 对象
-  const schemaObj = schema.toSchema ? schema.toSchema() : schema;
-  const properties = schemaObj.properties || {};
-
-  // 处理数组
-  if (Array.isArray(data)) {
-    return data.map((item) => smartCoerceTypes(item, schema));
-  }
-
-  // 处理对象
-  const result = { ...data };
-
-  Object.keys(result).forEach((key) => {
-    const value = result[key];
-    const fieldSchema = properties[key];
-
-    if (!fieldSchema) return;
-
-    // ⚠️ 关键修复：如果字段有 enum 约束，不进行类型转换
-    // 原因：枚举验证需要严格匹配类型
-    // 例如：数字枚举 [1,2,3] 不应该接受字符串 "1"
-    if (fieldSchema.enum) {
-      return; // 跳过枚举字段的转换
-    }
-
-    // 核心规则：只有同时满足以下三个条件才转换
-    // 1. 值是字符串
-    // 2. Schema 要求 number 类型
-    // 3. 能正常转换为有效数字
-    // 4. 不是枚举字段（已在上面检查）
-    if (fieldSchema.type === "number" && typeof value === "string") {
-      const trimmed = value.trim();
-      if (trimmed !== "") {
-        const num = Number(trimmed);
-        if (!isNaN(num)) {
-          result[key] = num;
-        }
-      }
-    }
-    // 处理嵌套对象
-    else if (
-      fieldSchema.type === "object" &&
-      typeof value === "object" &&
-      value !== null
-    ) {
-      result[key] = smartCoerceTypes(value, fieldSchema);
-    }
-    // 处理数组元素
-    else if (fieldSchema.type === "array" && Array.isArray(value)) {
-      if (fieldSchema.items && fieldSchema.items.type === "number") {
-        result[key] = value.map((item) => {
-          if (typeof item === "string") {
-            const trimmed = item.trim();
-            if (trimmed !== "") {
-              const num = Number(trimmed);
-              return !isNaN(num) ? num : item;
-            }
-          }
-          return item;
-        });
-      }
-    }
-  });
-
-  return result;
-}
-
-/**
- * 便捷验证方法（使用默认Validator）
- * @param {Object} schema - JSON Schema对象
- * @param {*} data - 待验证数据
- * @param {Object} [options] - 验证选项
- * @param {boolean} [options.format=true] - 是否格式化错误
- * @param {string} [options.locale] - 动态指定语言（如 'zh-CN', 'en-US'）
- * @param {Object} [options.messages] - 自定义错误消息
- * @param {boolean} [options.coerce=true] - 是否启用智能类型转换（字符串→数字）
- * @returns {Object} 验证结果
- *
- * @example
- * const { validate, dsl } = require('schema-dsl');
- *
- * const schema = dsl({ email: 'email!' });
- *
- * // 基本验证（默认启用智能转换）
- * const result1 = validate(schema, { userId: '123', age: '25' });
- * // userId 和 age 自动转为数字
- *
- * // 禁用智能转换
- * const result2 = validate(schema, data, { coerce: false });
- *
- * // 指定语言
- * const result3 = validate(schema, { email: 'invalid' }, { locale: 'zh-CN' });
- */
-function validate(schema, data, options = {}) {
-  // 默认启用智能转换（只转换字符串→数字）
-  const shouldCoerce = options.coerce !== false;
-
-  if (shouldCoerce) {
-    data = smartCoerceTypes(data, schema);
-  }
-
-  return getDefaultValidator().validate(schema, data, options);
-}
-
-// ========== 工具函数 ==========
-const { TypeConverter, SchemaHelper } = require("./lib/utils");
-const SchemaUtils = require("./lib/utils/SchemaUtils");
-
-// ========== 验证器扩展 ==========
-const { CustomKeywords } = require("./lib/validators");
-
-// ========== 常量 ==========
-const CONSTANTS = require("./lib/config/constants");
-
-// ========== 自动安装 String 扩展 ==========
-installStringExtensions(dsl);
-
-// ========== 导出 ==========
-
-// 导入 validateAsync
-const { validateAsync } = require("./lib/adapters/DslAdapter");
-
-module.exports = {
-  // 统一DSL API
-  dsl,
-  DslBuilder,
-
-  // 配置函数 (v1.0.4+)
-  config: dsl.config,
-
-  // String 扩展控制
-  installStringExtensions: () => installStringExtensions(dsl),
-  uninstallStringExtensions,
-
-  // 核心类
-  JSONSchemaCore,
-  Validator,
-
-  // 便捷方法（推荐）
-  validate, // 便捷验证（单例）
-  validateAsync, // v2.1.0 新增：异步验证
-  getDefaultValidator, // 获取单例Validator
-  ErrorFormatter,
-  CacheManager,
-
-  // 错误类 (v2.1.0 新增)
-  ValidationError,
-  I18nError, // v1.1.1 新增：多语言错误类
-
-  // 错误消息系统
-  ErrorCodes,
-  MessageTemplate,
-  Locale,
-
-  // 插件系统 (v2.2.0 新增)
-  PluginManager,
-
-  // 导出器
-  exporters,
-  MongoDBExporter: exporters.MongoDBExporter,
-  MySQLExporter: exporters.MySQLExporter,
-  PostgreSQLExporter: exporters.PostgreSQLExporter,
-  MarkdownExporter: exporters.MarkdownExporter,
-
-  // 工具函数
-  TypeConverter,
-  SchemaHelper,
-  SchemaUtils, // v2.0.1新增：Schema工具类
-
-  // 验证器扩展
-  CustomKeywords,
-
-  // 常量
-  CONSTANTS,
-
-  // 版本信息
-  VERSION: "1.2.3",
-};

package/index.mjs

@@ -1,60 +0,0 @@
-import schemaDsl from './index.js';
-
-export const {
-  // 统一DSL API
-  dsl,
-  DslBuilder,
-
-  // 配置函数 (v1.0.4+)
-  config,
-
-  // String 扩展控制
-  installStringExtensions,
-  uninstallStringExtensions,
-
-  // 核心类
-  JSONSchemaCore,
-  Validator,
-
-  // 便捷方法（推荐）
-  validate,
-  validateAsync,
-  getDefaultValidator,
-  ErrorFormatter,
-  CacheManager,
-
-  // 错误类 (v2.1.0 新增)
-  ValidationError,
-  I18nError,
-
-  // 错误消息系统
-  ErrorCodes,
-  MessageTemplate,
-  Locale,
-
-  // 插件系统 (v2.2.0 新增)
-  PluginManager,
-
-  // 导出器
-  exporters,
-  MongoDBExporter,
-  MySQLExporter,
-  PostgreSQLExporter,
-  MarkdownExporter,
-
-  // 工具函数
-  TypeConverter,
-  SchemaHelper,
-  SchemaUtils,
-
-  // 验证器扩展
-  CustomKeywords,
-
-  // 常量
-  CONSTANTS,
-
-  // 版本信息
-  VERSION
-} = schemaDsl;
-
-export default dsl;