node-mybatis-plus 0.1.0

package/dist/index.d.mts

@@ -0,0 +1,302 @@
+interface ColumnMeta {
+    propertyName: string;
+    columnName: string;
+    isPrimary: boolean;
+    idType?: 'auto' | 'uuid' | 'snowflake' | 'input';
+    exist: boolean;
+}
+interface EntityMeta {
+    tableName: string;
+    columns: ColumnMeta[];
+    idColumn: ColumnMeta | null;
+    target: Function;
+}
+interface Condition {
+    column: string;
+    op: '=' | '!=' | '>' | '>=' | '<' | '<=' | 'LIKE' | 'IN' | 'NOT IN' | 'BETWEEN' | 'IS NULL' | 'IS NOT NULL';
+    value?: any;
+    value2?: any;
+}
+interface ConditionGroup {
+    logic: 'AND' | 'OR';
+    items: (Condition | ConditionGroup)[];
+}
+interface OrderByItem {
+    column: string;
+    direction: 'ASC' | 'DESC';
+}
+interface SelectNode {
+    type: 'select';
+    table: string;
+    columns: string[];
+    where: ConditionGroup | null;
+    orderBy: OrderByItem[];
+    groupBy: string[];
+    having: ConditionGroup | null;
+    limit: {
+        offset: number;
+        count: number;
+    } | null;
+}
+interface InsertNode {
+    type: 'insert';
+    table: string;
+    columns: string[];
+    values: any[][];
+}
+interface UpdateNode {
+    type: 'update';
+    table: string;
+    sets: {
+        column: string;
+        value: any;
+    }[];
+    where: ConditionGroup | null;
+}
+interface DeleteNode {
+    type: 'delete';
+    table: string;
+    where: ConditionGroup | null;
+}
+type SqlNode = SelectNode | InsertNode | UpdateNode | DeleteNode;
+interface Dialect {
+    placeholder(index: number): string;
+    quote(identifier: string): string;
+    paginate(sql: string, offset: number, limit: number): string;
+    insertReturningId(table: string, columns: string[], idColumn: string): string | null;
+}
+interface PluginContext {
+    node: SqlNode;
+    sql: string;
+    params: any[];
+    entityMeta: EntityMeta;
+}
+interface Plugin {
+    name: string;
+    order: number;
+    beforeExecute?(ctx: PluginContext): Promise<void> | void;
+    afterExecute?(ctx: PluginContext, result: any): Promise<any> | any;
+}
+interface PoolConfig {
+    min?: number;
+    max?: number;
+    idleTimeout?: number;
+    acquireTimeout?: number;
+}
+interface DataSourceConfig {
+    type: 'mysql' | 'postgres' | 'sqlite';
+    host?: string;
+    port?: number;
+    database: string;
+    username?: string;
+    password?: string;
+    pool?: PoolConfig;
+    plugins?: Plugin[];
+    namingStrategy?: 'camelToSnake' | ((name: string) => string);
+}
+interface Connection {
+    query(sql: string, params: any[]): Promise<any>;
+    release(): void;
+}
+interface DataSource {
+    config: DataSourceConfig;
+    dialect: Dialect;
+    plugins: Plugin[];
+    getConnection(): Promise<Connection>;
+    execute(sql: string, params: any[]): Promise<any>;
+    close(): Promise<void>;
+    transaction<T>(fn: (tx: TransactionContext) => Promise<T>): Promise<T>;
+}
+interface TransactionContext {
+    connection: Connection;
+    commit(): Promise<void>;
+    rollback(): Promise<void>;
+}
+interface Page<T> {
+    records: T[];
+    total: number;
+    page: number;
+    size: number;
+    pages: number;
+}
+
+declare function Table(tableName: string): ClassDecorator;
+interface IdOptions {
+    type?: 'auto' | 'uuid' | 'snowflake' | 'input';
+}
+declare function Id(options?: IdOptions): PropertyDecorator;
+interface ColumnOptions {
+    name?: string;
+    exist?: boolean;
+}
+declare function Column(nameOrOptions?: string | ColumnOptions): PropertyDecorator;
+
+declare function createDataSource(config: DataSourceConfig): DataSource;
+
+/** 编程式事务（配合 AsyncLocalStorage 自动传播） */
+declare function withTransaction<T>(ds: DataSource, fn: () => Promise<T>): Promise<T>;
+declare function setDefaultDataSource(ds: DataSource): void;
+declare function getDefaultDataSource(): DataSource;
+interface TransactionalOptions {
+    datasource?: DataSource;
+}
+declare function Transactional(options?: TransactionalOptions): MethodDecorator;
+
+declare class MysqlDialect implements Dialect {
+    placeholder(_index: number): string;
+    quote(identifier: string): string;
+    paginate(sql: string, offset: number, limit: number): string;
+    insertReturningId(): null;
+}
+declare class PostgresDialect implements Dialect {
+    placeholder(index: number): string;
+    quote(identifier: string): string;
+    paginate(sql: string, offset: number, limit: number): string;
+    insertReturningId(_table: string, _columns: string[], idColumn: string): string;
+}
+declare class SqliteDialect implements Dialect {
+    placeholder(_index: number): string;
+    quote(identifier: string): string;
+    paginate(sql: string, offset: number, limit: number): string;
+    insertReturningId(): null;
+}
+declare function createDialect(type: string): Dialect;
+
+declare class AbstractWrapper<T, Self extends AbstractWrapper<T, Self>> {
+    protected entityMeta: EntityMeta;
+    protected conditionGroup: ConditionGroup;
+    protected _orderBy: OrderByItem[];
+    protected _groupBy: string[];
+    protected _having: ConditionGroup | null;
+    constructor(entityMeta: EntityMeta);
+    eq(column: keyof T & string, value: any): Self;
+    eq(condition: boolean, column: keyof T & string, value: any): Self;
+    ne(column: keyof T & string, value: any): Self;
+    ne(condition: boolean, column: keyof T & string, value: any): Self;
+    gt(column: keyof T & string, value: any): Self;
+    gt(condition: boolean, column: keyof T & string, value: any): Self;
+    ge(column: keyof T & string, value: any): Self;
+    ge(condition: boolean, column: keyof T & string, value: any): Self;
+    lt(column: keyof T & string, value: any): Self;
+    lt(condition: boolean, column: keyof T & string, value: any): Self;
+    le(column: keyof T & string, value: any): Self;
+    le(condition: boolean, column: keyof T & string, value: any): Self;
+    like(column: keyof T & string, value: string): Self;
+    like(condition: boolean, column: keyof T & string, value: string): Self;
+    likeLeft(column: keyof T & string, value: string): Self;
+    likeLeft(condition: boolean, column: keyof T & string, value: string): Self;
+    likeRight(column: keyof T & string, value: string): Self;
+    likeRight(condition: boolean, column: keyof T & string, value: string): Self;
+    between(column: keyof T & string, val1: any, val2: any): Self;
+    between(condition: boolean, column: keyof T & string, val1: any, val2: any): Self;
+    in(column: keyof T & string, values: any[]): Self;
+    in(condition: boolean, column: keyof T & string, values: any[]): Self;
+    notIn(column: keyof T & string, values: any[]): Self;
+    notIn(condition: boolean, column: keyof T & string, values: any[]): Self;
+    isNull(column: keyof T & string): Self;
+    isNull(condition: boolean, column: keyof T & string): Self;
+    isNotNull(column: keyof T & string): Self;
+    isNotNull(condition: boolean, column: keyof T & string): Self;
+    or(fn: (w: Self) => void): Self;
+    and(fn: (w: Self) => void): Self;
+    orderByAsc(...columns: (keyof T & string)[]): Self;
+    orderByDesc(...columns: (keyof T & string)[]): Self;
+    groupBy(...columns: (keyof T & string)[]): Self;
+    protected resolveColumn(propertyName: string): string;
+    getConditionGroup(): ConditionGroup;
+    getOrderBy(): OrderByItem[];
+    getGroupBy(): string[];
+    getHaving(): ConditionGroup | null;
+    private addCondition;
+    private parseArgs;
+    private createNested;
+}
+
+declare class LambdaQueryWrapper<T> extends AbstractWrapper<T, LambdaQueryWrapper<T>> {
+    private _columns;
+    private _limit;
+    private _datasource;
+    constructor(entityMeta: EntityMeta);
+    /** 绑定数据源（由 BaseMapper 调用） */
+    bindDataSource(ds: DataSource): this;
+    select(...columns: (keyof T & string)[]): this;
+    page(page: number, size: number): this;
+    /** 构建 SelectNode AST */
+    buildSelectNode(): SelectNode;
+    /** 终结操作：执行查询返回列表 */
+    list(): Promise<T[]>;
+    /** 终结操作：查询单条 */
+    one(): Promise<T | null>;
+    /** 终结操作：查询数量 */
+    count(): Promise<number>;
+    /** 终结操作：分页查询 */
+    pageResult(page: number, size: number): Promise<Page<T>>;
+    private requireDs;
+}
+
+declare class LambdaUpdateWrapper<T> extends AbstractWrapper<T, LambdaUpdateWrapper<T>> {
+    private _sets;
+    private _datasource;
+    constructor(entityMeta: EntityMeta);
+    bindDataSource(ds: DataSource): this;
+    set(column: keyof T & string, value: any): this;
+    set(condition: boolean, column: keyof T & string, value: any): this;
+    buildUpdateNode(): UpdateNode;
+    execute(): Promise<number>;
+}
+
+declare class BaseMapper<T extends object> {
+    protected entityMeta: EntityMeta;
+    protected ds: DataSource;
+    constructor(entityClass: Function, datasource: DataSource);
+    lambdaQuery(): LambdaQueryWrapper<T>;
+    lambdaUpdate(): LambdaUpdateWrapper<T>;
+    insert(entity: Partial<T>): Promise<number>;
+    insertBatch(entities: Partial<T>[]): Promise<number>;
+    deleteById(id: any): Promise<number>;
+    deleteBatchIds(ids: any[]): Promise<number>;
+    delete(wrapper: LambdaQueryWrapper<T>): Promise<number>;
+    updateById(entity: Partial<T>): Promise<number>;
+    update(entity: Partial<T>, wrapper: LambdaQueryWrapper<T>): Promise<number>;
+    selectById(id: any): Promise<T | null>;
+    selectBatchIds(ids: any[]): Promise<T[]>;
+    selectOne(wrapper: LambdaQueryWrapper<T>): Promise<T | null>;
+    selectList(wrapper?: LambdaQueryWrapper<T>): Promise<T[]>;
+    selectCount(wrapper?: LambdaQueryWrapper<T>): Promise<number>;
+    selectPage(page: number, size: number, wrapper?: LambdaQueryWrapper<T>): Promise<Page<T>>;
+    rawQuery(sql: string, params?: Record<string, any>): Promise<any>;
+    private extractColumns;
+    private getInsertableColumns;
+    private requireIdColumn;
+    private parseNamedParams;
+    /** 通过插件链路执行 SQL */
+    private executeWithPlugins;
+}
+
+interface CompiledSql {
+    sql: string;
+    params: any[];
+}
+declare class SqlBuilder {
+    private dialect;
+    private params;
+    private paramIndex;
+    constructor(dialect: Dialect);
+    build(node: SqlNode): CompiledSql;
+    private buildSelect;
+    private buildInsert;
+    private buildUpdate;
+    private buildDelete;
+    private buildConditionGroup;
+    private buildCondition;
+    private addParam;
+    private q;
+}
+
+/**
+ * 按 order 排序后依次执行插件的 beforeExecute，
+ * 执行 SQL，再依次执行 afterExecute，返回最终结果。
+ */
+declare function runPlugins(ds: DataSource, node: SqlNode, sql: string, params: any[], entityMeta: EntityMeta): Promise<any>;
+
+export { AbstractWrapper, BaseMapper, Column, type ColumnMeta, type ColumnOptions, type CompiledSql, type Condition, type ConditionGroup, type Connection, type DataSource, type DataSourceConfig, type DeleteNode, type Dialect, type EntityMeta, Id, type IdOptions, type InsertNode, LambdaQueryWrapper, LambdaUpdateWrapper, MysqlDialect, type OrderByItem, type Page, type Plugin, type PluginContext, type PoolConfig, PostgresDialect, type SelectNode, SqlBuilder, type SqlNode, SqliteDialect, Table, type TransactionContext, Transactional, type TransactionalOptions, type UpdateNode, createDataSource, createDialect, getDefaultDataSource, runPlugins, setDefaultDataSource, withTransaction };

package/dist/index.d.ts

@@ -0,0 +1,302 @@
+interface ColumnMeta {
+    propertyName: string;
+    columnName: string;
+    isPrimary: boolean;
+    idType?: 'auto' | 'uuid' | 'snowflake' | 'input';
+    exist: boolean;
+}
+interface EntityMeta {
+    tableName: string;
+    columns: ColumnMeta[];
+    idColumn: ColumnMeta | null;
+    target: Function;
+}
+interface Condition {
+    column: string;
+    op: '=' | '!=' | '>' | '>=' | '<' | '<=' | 'LIKE' | 'IN' | 'NOT IN' | 'BETWEEN' | 'IS NULL' | 'IS NOT NULL';
+    value?: any;
+    value2?: any;
+}
+interface ConditionGroup {
+    logic: 'AND' | 'OR';
+    items: (Condition | ConditionGroup)[];
+}
+interface OrderByItem {
+    column: string;
+    direction: 'ASC' | 'DESC';
+}
+interface SelectNode {
+    type: 'select';
+    table: string;
+    columns: string[];
+    where: ConditionGroup | null;
+    orderBy: OrderByItem[];
+    groupBy: string[];
+    having: ConditionGroup | null;
+    limit: {
+        offset: number;
+        count: number;
+    } | null;
+}
+interface InsertNode {
+    type: 'insert';
+    table: string;
+    columns: string[];
+    values: any[][];
+}
+interface UpdateNode {
+    type: 'update';
+    table: string;
+    sets: {
+        column: string;
+        value: any;
+    }[];
+    where: ConditionGroup | null;
+}
+interface DeleteNode {
+    type: 'delete';
+    table: string;
+    where: ConditionGroup | null;
+}
+type SqlNode = SelectNode | InsertNode | UpdateNode | DeleteNode;
+interface Dialect {
+    placeholder(index: number): string;
+    quote(identifier: string): string;
+    paginate(sql: string, offset: number, limit: number): string;
+    insertReturningId(table: string, columns: string[], idColumn: string): string | null;
+}
+interface PluginContext {
+    node: SqlNode;
+    sql: string;
+    params: any[];
+    entityMeta: EntityMeta;
+}
+interface Plugin {
+    name: string;
+    order: number;
+    beforeExecute?(ctx: PluginContext): Promise<void> | void;
+    afterExecute?(ctx: PluginContext, result: any): Promise<any> | any;
+}
+interface PoolConfig {
+    min?: number;
+    max?: number;
+    idleTimeout?: number;
+    acquireTimeout?: number;
+}
+interface DataSourceConfig {
+    type: 'mysql' | 'postgres' | 'sqlite';
+    host?: string;
+    port?: number;
+    database: string;
+    username?: string;
+    password?: string;
+    pool?: PoolConfig;
+    plugins?: Plugin[];
+    namingStrategy?: 'camelToSnake' | ((name: string) => string);
+}
+interface Connection {
+    query(sql: string, params: any[]): Promise<any>;
+    release(): void;
+}
+interface DataSource {
+    config: DataSourceConfig;
+    dialect: Dialect;
+    plugins: Plugin[];
+    getConnection(): Promise<Connection>;
+    execute(sql: string, params: any[]): Promise<any>;
+    close(): Promise<void>;
+    transaction<T>(fn: (tx: TransactionContext) => Promise<T>): Promise<T>;
+}
+interface TransactionContext {
+    connection: Connection;
+    commit(): Promise<void>;
+    rollback(): Promise<void>;
+}
+interface Page<T> {
+    records: T[];
+    total: number;
+    page: number;
+    size: number;
+    pages: number;
+}
+
+declare function Table(tableName: string): ClassDecorator;
+interface IdOptions {
+    type?: 'auto' | 'uuid' | 'snowflake' | 'input';
+}
+declare function Id(options?: IdOptions): PropertyDecorator;
+interface ColumnOptions {
+    name?: string;
+    exist?: boolean;
+}
+declare function Column(nameOrOptions?: string | ColumnOptions): PropertyDecorator;
+
+declare function createDataSource(config: DataSourceConfig): DataSource;
+
+/** 编程式事务（配合 AsyncLocalStorage 自动传播） */
+declare function withTransaction<T>(ds: DataSource, fn: () => Promise<T>): Promise<T>;
+declare function setDefaultDataSource(ds: DataSource): void;
+declare function getDefaultDataSource(): DataSource;
+interface TransactionalOptions {
+    datasource?: DataSource;
+}
+declare function Transactional(options?: TransactionalOptions): MethodDecorator;
+
+declare class MysqlDialect implements Dialect {
+    placeholder(_index: number): string;
+    quote(identifier: string): string;
+    paginate(sql: string, offset: number, limit: number): string;
+    insertReturningId(): null;
+}
+declare class PostgresDialect implements Dialect {
+    placeholder(index: number): string;
+    quote(identifier: string): string;
+    paginate(sql: string, offset: number, limit: number): string;
+    insertReturningId(_table: string, _columns: string[], idColumn: string): string;
+}
+declare class SqliteDialect implements Dialect {
+    placeholder(_index: number): string;
+    quote(identifier: string): string;
+    paginate(sql: string, offset: number, limit: number): string;
+    insertReturningId(): null;
+}
+declare function createDialect(type: string): Dialect;
+
+declare class AbstractWrapper<T, Self extends AbstractWrapper<T, Self>> {
+    protected entityMeta: EntityMeta;
+    protected conditionGroup: ConditionGroup;
+    protected _orderBy: OrderByItem[];
+    protected _groupBy: string[];
+    protected _having: ConditionGroup | null;
+    constructor(entityMeta: EntityMeta);
+    eq(column: keyof T & string, value: any): Self;
+    eq(condition: boolean, column: keyof T & string, value: any): Self;
+    ne(column: keyof T & string, value: any): Self;
+    ne(condition: boolean, column: keyof T & string, value: any): Self;
+    gt(column: keyof T & string, value: any): Self;
+    gt(condition: boolean, column: keyof T & string, value: any): Self;
+    ge(column: keyof T & string, value: any): Self;
+    ge(condition: boolean, column: keyof T & string, value: any): Self;
+    lt(column: keyof T & string, value: any): Self;
+    lt(condition: boolean, column: keyof T & string, value: any): Self;
+    le(column: keyof T & string, value: any): Self;
+    le(condition: boolean, column: keyof T & string, value: any): Self;
+    like(column: keyof T & string, value: string): Self;
+    like(condition: boolean, column: keyof T & string, value: string): Self;
+    likeLeft(column: keyof T & string, value: string): Self;
+    likeLeft(condition: boolean, column: keyof T & string, value: string): Self;
+    likeRight(column: keyof T & string, value: string): Self;
+    likeRight(condition: boolean, column: keyof T & string, value: string): Self;
+    between(column: keyof T & string, val1: any, val2: any): Self;
+    between(condition: boolean, column: keyof T & string, val1: any, val2: any): Self;
+    in(column: keyof T & string, values: any[]): Self;
+    in(condition: boolean, column: keyof T & string, values: any[]): Self;
+    notIn(column: keyof T & string, values: any[]): Self;
+    notIn(condition: boolean, column: keyof T & string, values: any[]): Self;
+    isNull(column: keyof T & string): Self;
+    isNull(condition: boolean, column: keyof T & string): Self;
+    isNotNull(column: keyof T & string): Self;
+    isNotNull(condition: boolean, column: keyof T & string): Self;
+    or(fn: (w: Self) => void): Self;
+    and(fn: (w: Self) => void): Self;
+    orderByAsc(...columns: (keyof T & string)[]): Self;
+    orderByDesc(...columns: (keyof T & string)[]): Self;
+    groupBy(...columns: (keyof T & string)[]): Self;
+    protected resolveColumn(propertyName: string): string;
+    getConditionGroup(): ConditionGroup;
+    getOrderBy(): OrderByItem[];
+    getGroupBy(): string[];
+    getHaving(): ConditionGroup | null;
+    private addCondition;
+    private parseArgs;
+    private createNested;
+}
+
+declare class LambdaQueryWrapper<T> extends AbstractWrapper<T, LambdaQueryWrapper<T>> {
+    private _columns;
+    private _limit;
+    private _datasource;
+    constructor(entityMeta: EntityMeta);
+    /** 绑定数据源（由 BaseMapper 调用） */
+    bindDataSource(ds: DataSource): this;
+    select(...columns: (keyof T & string)[]): this;
+    page(page: number, size: number): this;
+    /** 构建 SelectNode AST */
+    buildSelectNode(): SelectNode;
+    /** 终结操作：执行查询返回列表 */
+    list(): Promise<T[]>;
+    /** 终结操作：查询单条 */
+    one(): Promise<T | null>;
+    /** 终结操作：查询数量 */
+    count(): Promise<number>;
+    /** 终结操作：分页查询 */
+    pageResult(page: number, size: number): Promise<Page<T>>;
+    private requireDs;
+}
+
+declare class LambdaUpdateWrapper<T> extends AbstractWrapper<T, LambdaUpdateWrapper<T>> {
+    private _sets;
+    private _datasource;
+    constructor(entityMeta: EntityMeta);
+    bindDataSource(ds: DataSource): this;
+    set(column: keyof T & string, value: any): this;
+    set(condition: boolean, column: keyof T & string, value: any): this;
+    buildUpdateNode(): UpdateNode;
+    execute(): Promise<number>;
+}
+
+declare class BaseMapper<T extends object> {
+    protected entityMeta: EntityMeta;
+    protected ds: DataSource;
+    constructor(entityClass: Function, datasource: DataSource);
+    lambdaQuery(): LambdaQueryWrapper<T>;
+    lambdaUpdate(): LambdaUpdateWrapper<T>;
+    insert(entity: Partial<T>): Promise<number>;
+    insertBatch(entities: Partial<T>[]): Promise<number>;
+    deleteById(id: any): Promise<number>;
+    deleteBatchIds(ids: any[]): Promise<number>;
+    delete(wrapper: LambdaQueryWrapper<T>): Promise<number>;
+    updateById(entity: Partial<T>): Promise<number>;
+    update(entity: Partial<T>, wrapper: LambdaQueryWrapper<T>): Promise<number>;
+    selectById(id: any): Promise<T | null>;
+    selectBatchIds(ids: any[]): Promise<T[]>;
+    selectOne(wrapper: LambdaQueryWrapper<T>): Promise<T | null>;
+    selectList(wrapper?: LambdaQueryWrapper<T>): Promise<T[]>;
+    selectCount(wrapper?: LambdaQueryWrapper<T>): Promise<number>;
+    selectPage(page: number, size: number, wrapper?: LambdaQueryWrapper<T>): Promise<Page<T>>;
+    rawQuery(sql: string, params?: Record<string, any>): Promise<any>;
+    private extractColumns;
+    private getInsertableColumns;
+    private requireIdColumn;
+    private parseNamedParams;
+    /** 通过插件链路执行 SQL */
+    private executeWithPlugins;
+}
+
+interface CompiledSql {
+    sql: string;
+    params: any[];
+}
+declare class SqlBuilder {
+    private dialect;
+    private params;
+    private paramIndex;
+    constructor(dialect: Dialect);
+    build(node: SqlNode): CompiledSql;
+    private buildSelect;
+    private buildInsert;
+    private buildUpdate;
+    private buildDelete;
+    private buildConditionGroup;
+    private buildCondition;
+    private addParam;
+    private q;
+}
+
+/**
+ * 按 order 排序后依次执行插件的 beforeExecute，
+ * 执行 SQL，再依次执行 afterExecute，返回最终结果。
+ */
+declare function runPlugins(ds: DataSource, node: SqlNode, sql: string, params: any[], entityMeta: EntityMeta): Promise<any>;
+
+export { AbstractWrapper, BaseMapper, Column, type ColumnMeta, type ColumnOptions, type CompiledSql, type Condition, type ConditionGroup, type Connection, type DataSource, type DataSourceConfig, type DeleteNode, type Dialect, type EntityMeta, Id, type IdOptions, type InsertNode, LambdaQueryWrapper, LambdaUpdateWrapper, MysqlDialect, type OrderByItem, type Page, type Plugin, type PluginContext, type PoolConfig, PostgresDialect, type SelectNode, SqlBuilder, type SqlNode, SqliteDialect, Table, type TransactionContext, Transactional, type TransactionalOptions, type UpdateNode, createDataSource, createDialect, getDefaultDataSource, runPlugins, setDefaultDataSource, withTransaction };