@pangza/orm 0.0.0-stage → 1.0.1

package/README.md

@@ -1,3 +1,3 @@
-# Temporary Holding Version
+# @pangza/orm
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+ORM / Db / Mapper / QueryWrapper

package/dist/BaseMapper.d.ts

@@ -0,0 +1,112 @@
+import { QueryWrapper } from "./QueryWrapper";
+import type { IPage, MapperOptions, PageQuery, SelectQueryOptions } from "./types";
+/**
+ * 通用 Mapper（对齐 MyBatis-Plus BaseMapper）
+ * 支持逻辑删除、自动填充、乐观锁（均可配置开关）。
+ */
+export declare class BaseMapper<T extends Record<string, any> = Record<string, any>> {
+    private readonly opts;
+    private readonly dialect;
+    constructor(options: MapperOptions);
+    /** 更新字段是否参与 SET（undefined 永不参与；null 受 updateNullStrategy 控制） */
+    private shouldWriteUpdateValue;
+    private query;
+    private tx;
+    private cfg;
+    /** 是否启用逻辑删除（表级优先，否则读全局） */
+    private isLogicDelete;
+    /** 是否启用乐观锁（表级优先，否则读全局） */
+    private isOptimisticLock;
+    /** 未删除条件（对齐 MyBatis-Plus：字段 = 未删除值） */
+    private notDeletedClause;
+    private tableSql;
+    private idSql;
+    private colSql;
+    /**
+     * 把实体属性名映射为列名，并去掉 exist:false 字段，
+     * 避免 createTime / create_time 双键写入 SQL。
+     */
+    private normalizeEntityRow;
+    private columnNames;
+    private getColumnNames;
+    /** 表上不存在的自动填充字段直接丢掉，避免 Unknown column */
+    private stripMissingFillFields;
+    private assertLogicDeleteColumn;
+    /** 追加未删除条件（不修改调用方 wrapper） */
+    private withLogic;
+    private hydrateOpts;
+    private normalizeListArgs;
+    /** 按主键查询 */
+    selectById(id: string | number, options?: SelectQueryOptions): Promise<T | null>;
+    /** 条件查询单条 */
+    selectOne(wrapper?: QueryWrapper, options?: SelectQueryOptions): Promise<T | null>;
+    /** WHERE + GROUP BY + HAVING + ORDER BY + LAST（去多余空格） */
+    private fragTail;
+    /** 有 GROUP BY 时用子查询计组数，否则普通 COUNT */
+    private countSqlFromFrag;
+    /**
+     * 条件查询列表。
+     * @param limitOrOptions 数字 limit，或 `{ limit, relations }`
+     */
+    selectList(wrapper?: QueryWrapper | SelectQueryOptions, limitOrOptions?: number | SelectQueryOptions): Promise<T[]>;
+    /** 条件计数（含 GROUP BY 时返回分组行数） */
+    selectCount(wrapper?: QueryWrapper): Promise<number>;
+    /** 分页查询 */
+    selectPage(page?: PageQuery, wrapper?: QueryWrapper, options?: SelectQueryOptions): Promise<IPage<T>>;
+    /** 解析有效主键策略 */
+    private resolveIdType;
+    /** 插入前按 IdType 填充 / 剥离主键 */
+    private applyIdOnInsert;
+    /** 把生成的主键回写到原始实体 */
+    private writeBackId;
+    /** 插入，返回自增 id（若有）；ASSIGN_* 时尽量回写实体并返回可解析的数字 */
+    insert(entity: Partial<T>): Promise<number>;
+    /**
+     * 批量插入，返回影响行数。
+     * 多行一条 INSERT，按 `orm.batch.insertSize`（默认 200）分批。
+     */
+    saveBatch(entities: Array<Partial<T>>): Promise<number>;
+    private prepareInsertRow;
+    private insertOne;
+    /** 多行同一列集合；缺省列写 NULL */
+    private insertMany;
+    /** 按主键更新（忽略 undefined 字段） */
+    updateById(entity: Partial<T>): Promise<number>;
+    /**
+     * 有主键且库中存在则 updateById，否则 insert。
+     * 返回影响行数（insert / update 语义与各自方法一致）。
+     */
+    saveOrUpdate(entity: Partial<T>): Promise<number>;
+    /**
+     * 按主键批量更新（逐条 updateById，同一事务）。
+     * 分批大小取 `orm.batch.updateSize`（默认 200）。
+     */
+    updateBatch(entities: Array<Partial<T>>): Promise<number>;
+    /** 条件更新 */
+    update(entity: Partial<T>, wrapper: QueryWrapper): Promise<number>;
+    /** 按主键删除（开启逻辑删除时改为 UPDATE） */
+    deleteById(id: string | number): Promise<number>;
+    /**
+     * 按主键批量删除，返回影响行数。
+     * 开启逻辑删除时一条 UPDATE ... IN (...)，否则物理 DELETE。
+     */
+    deleteByIds(ids: Array<string | number>): Promise<number>;
+    /**
+     * 按主键物理删除（始终 DELETE，忽略逻辑删除开关）。
+     * 用于彻底清除或回收站清空。
+     */
+    physicalDeleteById(id: string | number): Promise<number>;
+    /** 按主键批量物理删除 */
+    physicalDeleteByIds(ids: Array<string | number>): Promise<number>;
+    /** 条件删除（开启逻辑删除时改为 UPDATE） */
+    delete(wrapper: QueryWrapper): Promise<number>;
+    /**
+     * 条件物理删除（始终 DELETE）。
+     * 必须带 WHERE；不会自动附加「未删除」条件（可删已逻辑删除行）。
+     */
+    physicalDelete(wrapper: QueryWrapper): Promise<number>;
+    private deleteByIdsInternal;
+    private deleteByWrapper;
+    private logicDeleteBy;
+}
+//# sourceMappingURL=BaseMapper.d.ts.map

package/dist/BaseMapper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseMapper.d.ts","sourceRoot":"","sources":["../src/BaseMapper.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAG9C,OAAO,KAAK,EACV,KAAK,EACL,aAAa,EACb,SAAS,EAET,kBAAkB,EACnB,MAAM,SAAS,CAAC;AAmBjB;;;GAGG;AACH,qBAAa,UAAU,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IACzE,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAgB;IACrC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAU;gBAEtB,OAAO,EAAE,aAAa;IA0BlC,gEAAgE;IAChE,OAAO,CAAC,sBAAsB;YAQhB,KAAK;YAOL,EAAE;IAIhB,OAAO,CAAC,GAAG;IAIX,2BAA2B;IAC3B,OAAO,CAAC,aAAa;IAIrB,0BAA0B;IAC1B,OAAO,CAAC,gBAAgB;IAIxB,uCAAuC;IACvC,OAAO,CAAC,gBAAgB;IAQxB,OAAO,CAAC,QAAQ;IAIhB,OAAO,CAAC,KAAK;IAIb,OAAO,CAAC,MAAM;IAId;;;OAGG;IACH,OAAO,CAAC,kBAAkB;IAyB1B,OAAO,CAAC,WAAW,CAA4B;YAEjC,cAAc;IAW5B,yCAAyC;YAC3B,sBAAsB;YAetB,uBAAuB;IAarC,8BAA8B;IAC9B,OAAO,CAAC,SAAS;IAUjB,OAAO,CAAC,WAAW;IAmBnB,OAAO,CAAC,iBAAiB;IAwBzB,YAAY;IACN,UAAU,CACd,EAAE,EAAE,MAAM,GAAG,MAAM,EACnB,OAAO,CAAC,EAAE,kBAAkB,GAC3B,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;IAOpB,aAAa;IACP,SAAS,CACb,OAAO,CAAC,EAAE,YAAY,EACtB,OAAO,CAAC,EAAE,kBAAkB,GAC3B,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;IAQpB,yDAAyD;IACzD,OAAO,CAAC,QAAQ;IAYhB,qCAAqC;IACrC,OAAO,CAAC,gBAAgB;IAiBxB;;;OAGG;IACG,UAAU,CACd,OAAO,CAAC,EAAE,YAAY,GAAG,kBAAkB,EAC3C,cAAc,CAAC,EAAE,MAAM,GAAG,kBAAkB,GAC3C,OAAO,CAAC,CAAC,EAAE,CAAC;IA0Bf,+BAA+B;IACzB,WAAW,CAAC,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC;IAQ1D,WAAW;IACL,UAAU,CACd,IAAI,GAAE,SAAc,EACpB,OAAO,CAAC,EAAE,YAAY,EACtB,OAAO,CAAC,EAAE,kBAAkB,GAC3B,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IA+BpB,eAAe;IACf,OAAO,CAAC,aAAa;IASrB,4BAA4B;YACd,eAAe;IA6C7B,oBAAoB;IACpB,OAAO,CAAC,WAAW;IA0BnB,+CAA+C;IACzC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IAYjD;;;OAGG;IACG,SAAS,CAAC,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;YAyB/C,gBAAgB;YAyBhB,SAAS;IAqBvB,wBAAwB;YACV,UAAU;IA2BxB,6BAA6B;IACvB,UAAU,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IAyDrD;;;OAGG;IACG,YAAY,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IAgBvD;;;OAGG;IACG,WAAW,CAAC,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IAmB/D,WAAW;IACL,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC;IAgDxE,8BAA8B;IACxB,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAItD;;;OAGG;IACG,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IAI/D;;;OAGG;IACG,kBAAkB,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAI9D,gBAAgB;IACV,mBAAmB,CAAC,GAAG,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IAIvE,6BAA6B;IACvB,MAAM,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC;IAIpD;;;OAGG;IACG,cAAc,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC;YAI9C,mBAAmB;YAgCnB,eAAe;YA0Bf,aAAa;CAkB5B"}