monsqlize 1.3.0 → 2.0.0

package/types/expression.ts

@@ -1,109 +0,0 @@
-/**
- * 统一表达式系统类型定义
- * @module types/expression
- * @since v1.0.9
- * @updated v1.1.0 - 新增49个操作符，实现100% MongoDB支持
- */
-
-/**
- * 支持的统一表达式操作符（122个 - 100% MongoDB支持）
- * @since v1.0.9
- * @updated v1.1.0
- */
-export namespace UnifiedExpressionOperators {
-    /** 三元运算符 */
-    export type TernaryOperator = '? :';
-
-    /** 空值合并运算符 */
-    export type NullishCoalescing = '??';
-
-    /** 比较运算符 */
-    export type ComparisonOperators = '>' | '>=' | '<' | '<=' | '===' | '!==';
-
-    /** 逻辑运算符 */
-    export type LogicalOperators = '&&' | '||' | 'NOT';
-
-    /** 算术运算符 */
-    export type ArithmeticOperators = '+' | '-' | '*' | '/' | '%';
-
-    /** 数学函数（8个）*/
-    export type MathFunctions = 'ABS' | 'CEIL' | 'FLOOR' | 'ROUND' | 'SQRT' | 'POW' | 'LOG' | 'LOG10';
-
-    /** 字符串基础函数（12个）*/
-    export type StringBasicFunctions = 'CONCAT' | 'UPPER' | 'LOWER' | 'TRIM' | 'SUBSTR' | 'LENGTH' |
-        'SPLIT' | 'REPLACE' | 'INDEX_OF_STR' | 'LTRIM' | 'RTRIM' | 'SUBSTR_CP';
-
-    /** 字符串扩展函数（3个）v1.1.0 */
-    export type StringExtendedFunctions = 'STR_LEN_BYTES' | 'STR_LEN_CP' | 'SUBSTR_BYTES';
-
-    /** 数组基础函数（13个）*/
-    export type ArrayBasicFunctions = 'SIZE' | 'ARRAY_ELEM_AT' | 'IN' | 'SLICE' | 'FIRST' | 'LAST' |
-        'FILTER' | 'MAP' | 'INDEX_OF' | 'CONCAT_ARRAYS';
-
-    /** 数组扩展函数（4个）v1.1.0 */
-    export type ArrayExtendedFunctions = 'REDUCE' | 'ZIP' | 'REVERSE_ARRAY' | 'RANGE';
-
-    /** 日期基础函数（6个）*/
-    export type DateBasicFunctions = 'YEAR' | 'MONTH' | 'DAY_OF_MONTH' | 'HOUR' | 'MINUTE' | 'SECOND';
-
-    /** 日期高级函数（5个）v1.1.0 */
-    export type DateAdvancedFunctions = 'DATE_ADD' | 'DATE_SUBTRACT' | 'DATE_DIFF' | 'DATE_TO_STRING' | 'DATE_FROM_STRING';
-
-    /** 日期扩展函数（8个）v1.1.0 */
-    export type DateExtendedFunctions = 'DATE_FROM_PARTS' | 'DATE_TO_PARTS' | 'ISO_WEEK' | 'ISO_WEEK_YEAR' |
-        'ISO_DAY_OF_WEEK' | 'DAY_OF_WEEK' | 'DAY_OF_YEAR' | 'WEEK';
-
-    /** 类型检查函数（5个）*/
-    export type TypeCheckFunctions = 'TYPE' | 'IS_NUMBER' | 'IS_ARRAY' | 'EXISTS' | 'NOT';
-
-    /** 类型转换基础函数（3个）*/
-    export type TypeConversionBasicFunctions = 'TO_INT' | 'TO_STRING' | 'OBJECT_TO_ARRAY' | 'ARRAY_TO_OBJECT';
-
-    /** 类型转换扩展函数（7个）v1.1.0 */
-    export type TypeConversionExtendedFunctions = 'TO_BOOL' | 'TO_DATE' | 'TO_DOUBLE' | 'TO_DECIMAL' |
-        'TO_LONG' | 'TO_OBJECT_ID' | 'CONVERT';
-
-    /** 逻辑扩展函数（2个）v1.1.0 */
-    export type LogicalExtendedFunctions = 'ALL_ELEMENTS_TRUE' | 'ANY_ELEMENT_TRUE';
-
-    /** 条件函数（3个）*/
-    export type ConditionalFunctions = 'SWITCH' | 'COND' | 'IF_NULL';
-
-    /** 对象操作函数（5个）*/
-    export type ObjectOperationFunctions = 'MERGE_OBJECTS' | 'SET_FIELD' | 'UNSET_FIELD' | 'GET_FIELD' | 'OBJECT_TO_ARRAY';
-
-    /** 集合操作函数（5个）*/
-    export type SetOperationFunctions = 'SET_UNION' | 'SET_DIFFERENCE' | 'SET_EQUALS' | 'SET_INTERSECTION' | 'SET_IS_SUBSET';
-
-    /** 高级操作函数（4个）v1.1.0 */
-    export type AdvancedOperationFunctions = 'LET' | 'LITERAL' | 'RAND' | 'SAMPLE_RATE' | 'REGEX';
-
-    /** 聚合累加器（7个）*/
-    export type AggregateFunctions = 'SUM' | 'AVG' | 'MAX' | 'MIN' | 'COUNT' | 'PUSH' | 'ADD_TO_SET';
-
-    /** 所有操作符联合类型 */
-    export type AllOperators =
-        | TernaryOperator
-        | NullishCoalescing
-        | ComparisonOperators
-        | LogicalOperators
-        | ArithmeticOperators
-        | MathFunctions
-        | StringBasicFunctions
-        | StringExtendedFunctions
-        | ArrayBasicFunctions
-        | ArrayExtendedFunctions
-        | DateBasicFunctions
-        | DateAdvancedFunctions
-        | DateExtendedFunctions
-        | TypeCheckFunctions
-        | TypeConversionBasicFunctions
-        | TypeConversionExtendedFunctions
-        | LogicalExtendedFunctions
-        | ConditionalFunctions
-        | ObjectOperationFunctions
-        | SetOperationFunctions
-        | AdvancedOperationFunctions
-        | AggregateFunctions;
-}
-

package/types/function-cache.d.ts

@@ -1,135 +0,0 @@
-/**
- * 函数缓存类型定义
- * 🆕 v1.1.4: 通用函数缓存
- */
-
-/**
- * withCache 配置选项
- */
-export interface WithCacheOptions<T extends (...args: any[]) => any> {
-    /** 缓存时间（毫秒） */
-    ttl?: number;
-
-    /** 自定义键生成函数 */
-    keyBuilder?: (...args: Parameters<T>) => string;
-
-    /** 缓存实例 */
-    cache?: import('./cache').CacheLike;
-
-    /** 命名空间 */
-    namespace?: string;
-
-    /** 条件缓存函数 */
-    condition?: (result: Awaited<ReturnType<T>>) => boolean;
-
-    /** 启用统计 */
-    enableStats?: boolean;
-}
-
-/**
- * 缓存统计信息
- */
-export interface CacheStats {
-    /** 命中次数 */
-    hits: number;
-
-    /** 未命中次数 */
-    misses: number;
-
-    /** 错误次数 */
-    errors: number;
-
-    /** 总调用次数 */
-    calls: number;
-
-    /** 总耗时（毫秒） */
-    totalTime: number;
-
-    /** 命中率 */
-    hitRate: number;
-
-    /** 平均耗时（毫秒） */
-    avgTime: number;
-}
-
-/**
- * FunctionCache 配置选项
- */
-export interface FunctionCacheOptions {
-    /** 命名空间 */
-    namespace?: string;
-
-    /** 默认 TTL（毫秒） */
-    defaultTTL?: number;
-
-    /** 启用统计 */
-    enableStats?: boolean;
-}
-
-/**
- * 包装后的函数（带统计方法）
- */
-export type CachedFunction<T extends (...args: any[]) => any> = T & {
-    getCacheStats(): CacheStats;
-};
-
-/**
- * 为函数添加缓存能力
- */
-export function withCache<T extends (...args: any[]) => any>(
-    fn: T,
-    options?: WithCacheOptions<T>
-): CachedFunction<T>;
-
-/**
- * 函数缓存管理类
- */
-export class FunctionCache {
-    constructor(msq?: any, options?: FunctionCacheOptions);
-
-    /**
-     * 注册函数
-     * 🔧 v1.1.4-hotfix: 改为异步方法
-     */
-    register<T extends (...args: any[]) => any>(
-        name: string,
-        fn: T,
-        options?: WithCacheOptions<T>
-    ): Promise<void>;
-
-    /**
-     * 执行函数
-     */
-    execute<T = any>(name: string, ...args: any[]): Promise<T>;
-
-    /**
-     * 失效缓存
-     */
-    invalidate(name: string, ...args: any[]): Promise<void>;
-
-    /**
-     * 批量失效缓存
-     */
-    invalidatePattern(pattern: string): Promise<number>;
-
-    /**
-     * 获取统计信息
-     */
-    getStats(name?: string): CacheStats | Record<string, CacheStats> | null;
-
-    /**
-     * 列出所有已注册的函数
-     */
-    list(): string[];
-
-    /**
-     * 重置统计信息
-     */
-    resetStats(name?: string): void;
-
-    /**
-     * 清空所有已注册的函数
-     */
-    clear(): void;
-}
-

package/types/lock.ts

@@ -1,95 +0,0 @@
-/**
- * 业务锁相关类型定义
- * @module types/lock
- * @since v1.4.0
- */
-
-/**
- * 业务锁配置选项
- * @since v1.4.0
- */
-export interface LockOptions {
-    /** 锁过期时间（毫秒），默认 10000 */
-    ttl?: number;
-    /** 获取锁失败时的重试次数，默认 3 */
-    retryTimes?: number;
-    /** 重试间隔（毫秒），默认 100 */
-    retryDelay?: number;
-    /** Redis 不可用时是否降级为无锁执行，默认 false */
-    fallbackToNoLock?: boolean;
-}
-
-/**
- * 锁对象
- * 表示一个已获取的锁，提供释放和续期方法
- * @since v1.4.0
- */
-export interface Lock {
-    /** 锁的 Key */
-    readonly key: string;
-    /** 锁的唯一ID */
-    readonly lockId: string;
-    /** 是否已释放 */
-    readonly released: boolean;
-
-    /**
-     * 释放锁
-     * @returns Promise<boolean> 是否成功释放
-     */
-    release(): Promise<boolean>;
-
-    /**
-     * 续期（延长 TTL）
-     * @param ttl - 新的过期时间（毫秒），默认使用原TTL
-     * @returns Promise<boolean> 是否成功续期
-     */
-    renew(ttl?: number): Promise<boolean>;
-
-    /**
-     * 检查锁是否仍被持有
-     * @returns boolean
-     */
-    isHeld(): boolean;
-
-    /**
-     * 获取锁持有时间（毫秒）
-     * @returns number
-     */
-    getHoldTime(): number;
-}
-
-/**
- * 锁统计信息
- * @since v1.4.0
- */
-export interface LockStats {
-    /** 成功获取锁的次数 */
-    locksAcquired: number;
-    /** 成功释放锁的次数 */
-    locksReleased: number;
-    /** 锁检查次数 */
-    lockChecks: number;
-    /** 错误次数 */
-    errors: number;
-    /** 锁键前缀 */
-    lockKeyPrefix: string;
-    /** 锁最大持续时间 */
-    maxDuration: number;
-}
-
-/**
- * 锁获取失败错误
- * @since v1.4.0
- */
-export interface LockAcquireError extends Error {
-    readonly code: 'LOCK_ACQUIRE_FAILED';
-}
-
-/**
- * 锁超时错误
- * @since v1.4.0
- */
-export interface LockTimeoutError extends Error {
-    readonly code: 'LOCK_TIMEOUT';
-}
-

package/types/model/definition.ts

@@ -1,152 +0,0 @@
-/**
- * Model 定义相关类型
- * @module types/model/definition
- * @since v1.0.3
- */
-
-/**
- * Schema DSL 函数类型
- */
-export type SchemaDSL = (dsl: any) => any;
-
-/**
- * 默认值类型
- * @since v1.0.6
- */
-export type DefaultValue<T = any> = T | ((context?: any, doc?: any) => T);
-
-/**
- * 钩子上下文
- */
-export interface HookContext {
-    operation: string;
-    collection: string;
-    data?: any;
-    filter?: any;
-    update?: any;
-    result?: any;
-    error?: Error;
-    [key: string]: any;
-}
-
-/**
- * 验证结果
- */
-export interface ValidationResult {
-    valid: boolean;
-    errors?: Array<{
-        field: string;
-        message: string;
-        value?: any;
-    }>;
-}
-
-/**
- * Model 定义配置
- */
-export interface ModelDefinition<T = any> {
-    /**
-     * 枚举配置（可被 schema 引用）
-     * @example
-     * enums: {
-     *   role: 'admin|user|guest',
-     *   status: 'active|inactive'
-     * }
-     */
-    enums?: Record<string, string>;
-
-    /**
-     * Schema 定义（数据验证规则）
-     * 使用 function 时，this 自动绑定到 definition，可访问 this.enums
-     */
-    schema?: SchemaDSL | Record<string, any>;
-
-    /**
-     * 默认值配置
-     * @example
-     * defaults: {
-     *   status: 'active',
-     *   createdAt: () => new Date()
-     * }
-     */
-    defaults?: Record<string, DefaultValue>;
-
-    /**
-     * 钩子函数配置
-     */
-    hooks?: {
-        beforeCreate?: (context: HookContext) => Promise<void> | void;
-        afterCreate?: (context: HookContext) => Promise<void> | void;
-        beforeUpdate?: (context: HookContext) => Promise<void> | void;
-        afterUpdate?: (context: HookContext) => Promise<void> | void;
-        beforeDelete?: (context: HookContext) => Promise<void> | void;
-        afterDelete?: (context: HookContext) => Promise<void> | void;
-        beforeFind?: (context: HookContext) => Promise<void> | void;
-        afterFind?: (context: HookContext) => Promise<void> | void;
-    };
-
-    /**
-     * 方法配置（实例方法）
-     * @example
-     * methods: {
-     *   fullName: function() {
-     *     return `${this.firstName} ${this.lastName}`;
-     *   }
-     * }
-     */
-    methods?: Record<string, (this: any, ...args: any[]) => any>;
-
-    /**
-     * 静态方法配置（Model 静态方法）
-     * @example
-     * statics: {
-     *   findByRole: async function(role) {
-     *     return this.find({ role });
-     *   }
-     * }
-     */
-    statics?: Record<string, (...args: any[]) => any>;
-
-    /**
-     * 数据源绑定配置（v1.2.2+）
-     *
-     * 声明此 Model 使用哪个连接池和/或数据库。
-     * 不配置时行为与 v1.2.1 完全相同（向后兼容）。
-     *
-     * @example
-     * // 绑定到指定连接池 + 数据库
-     * connection: { pool: 'analytics', database: 'reports_db' }
-     *
-     * @example
-     * // 只切换数据库（使用默认连接池）
-     * connection: { database: 'logs_db' }
-     *
-     * @since v1.2.2
-     */
-    connection?: ModelConnection;
-}
-
-/**
- * Model 数据源绑定配置
- *
- * 声明 Model 使用哪个连接池（pool）和/或数据库（database）。
- * 两个字段均为可选：
- *   - 只指定 pool   → 使用该池 + 实例初始化时的 databaseName
- *   - 只指定 database → 使用默认连接池 + 指定数据库
- *   - 两者都指定    → 使用指定池 + 指定数据库
- *   - 均不指定      → 与原来完全相同（向后兼容）
- *
- * @since v1.2.2
- */
-export interface ModelConnection {
-    /**
-     * 连接池名称，须与 MonSQLize 构造函数 `pools[].name` 对应
-     */
-    pool?: string;
-
-    /**
-     * 数据库名称，不指定时使用实例初始化时的 `databaseName`
-     */
-    database?: string;
-}
-

package/types/model/index.ts

@@ -1,10 +0,0 @@
-/**
- * Model 层类型汇总导出
- * @module types/model
- */
-
-export * from './definition';
-export * from './relations';
-export * from './virtuals';
-export * from './instance';
-

package/types/model/instance.ts

@@ -1,121 +0,0 @@
-/**
- * Model 实例和静态类相关类型
- * @module types/model/instance
- * @since v1.0.3
- */
-
-import type { ModelDefinition, ValidationResult } from "./definition";
-import type { PopulateProxy } from "./relations";
-
-/**
- * Model 注册表条目（Model.get() 的返回值结构）
- * @since 1.1.7
- */
-export interface RegisteredModel<T = any> {
-  collectionName: string;
-  definition: ModelDefinition<T>;
-}
-
-/**
- * Model 实例接口
- * 文档实例的扩展方法
- */
-export interface ModelInstance<T = any> {
-  /**
-   * 保存文档（插入或更新）
-   */
-  save(): Promise<T>;
-
-  /**
-   * 删除文档
-   */
-  remove(): Promise<boolean>;
-
-  /**
-   * 验证文档
-   */
-  validate(): Promise<ValidationResult>;
-
-  /**
-   * 关联查询（populate）
-   */
-  populate(path: string): PopulateProxy<T>;
-  populate(config: any): PopulateProxy<T>;
-
-  /**
-   * 转换为普通对象
-   */
-  toObject(): T;
-
-  /**
-   * 转换为 JSON
-   */
-  toJSON(): any;
-}
-
-/**
- * Model 命名空间（静态方法）
- */
-export declare namespace Model {
-  /**
-   * 注册一个 Model 定义
-   *
-   * @param collectionName - 集合名称
-   * @param definition - Model 定义对象
-   * @throws {Error} 集合名称无效、schema 未定义、Model 已存在
-   */
-  function define<T = any>(
-    collectionName: string,
-    definition: ModelDefinition<T>,
-  ): void;
-
-  /**
-   * 获取已注册的 Model 条目
-   *
-   * @param collectionName - 集合名称
-   * @returns 注册条目 { collectionName, definition }，如果不存在返回 undefined
-   */
-  function get<T = any>(collectionName: string): RegisteredModel<T> | undefined;
-
-  /**
-   * 检查 Model 是否已注册
-   *
-   * @param collectionName - 集合名称
-   * @returns boolean
-   */
-  function has(collectionName: string): boolean;
-
-  /**
-   * 列出所有已注册的 Model 名称
-   *
-   * @returns 集合名称数组
-   */
-  function list(): string[];
-
-  /**
-   * 注销已注册的 Model 定义
-   *
-   * 从全局注册表中移除指定的 Model 定义。
-   * 已实例化的 ModelInstance 不受影响，仅影响后续通过 msq.model() 获取的新实例。
-   *
-   * @param collectionName - 集合名称
-   * @returns 如果成功移除返回 true，如果 Model 不存在返回 false
-   * @since 1.1.7
-   */
-  function undefine(collectionName: string): boolean;
-
-  /**
-   * 重新定义已注册的 Model（undefine + define 的组合操作）
-   *
-   * 如果 Model 不存在，行为等同于 define()（首次注册）。
-   * 注意：如果新的 definition 校验失败，旧定义将被移除。
-   *
-   * @param collectionName - 集合名称
-   * @param definition - 新的 Model 定义对象
-   * @since 1.1.7
-   */
-  function redefine<T = any>(
-    collectionName: string,
-    definition: ModelDefinition<T>,
-  ): void;
-}