@eggjs/dal-runtime 4.0.0-beta.7 → 4.0.0-beta.8

package/dist/index.d.ts

@@ -1,15 +1,244 @@
-import { BaseSqlMapGenerator } from "./BaseSqlMap.js";
-import { CodeGenerator } from "./CodeGenerator.js";
-import { DaoLoader } from "./DaoLoader.js";
-import { DataSourceOptions, MysqlDataSource } from "./MySqlDataSource.js";
-import { DatabaseForker } from "./DatabaseForker.js";
-import { TableSqlMap } from "./TableSqlMap.js";
-import { DataSource, ExecuteSql } from "./DataSource.js";
-import { NunjucksConverter } from "./NunjucksConverter.js";
-import { NunjucksUtils } from "./NunjucksUtil.js";
-import { SqlGenerator } from "./SqlGenerator.js";
-import { SqlMapLoader } from "./SqlMapLoader.js";
-import { SqlUtil } from "./SqlUtil.js";
-import { TableModelInstanceBuilder } from "./TableModelInstanceBuilder.js";
-import { TemplateUtil } from "./TemplateUtil.js";
+import { BaseDaoType, ColumnModel, TableModel } from "@eggjs/dal-decorator";
+import { CodeGeneratorOptions, ColumnType, DataSource as DataSource$1, GenerateSqlMap, Geometry, GeometryCollection, Line, Logger, MultiLine, MultiPoint, MultiPolygon, PaginateData, Point, Polygon, SqlMap, SqlType, Templates } from "@eggjs/tegg-types";
+import nunjucks, { Template } from "nunjucks";
+import { BaseDaoType as BaseDaoType$1 } from "@eggjs/tegg-types/dal";
+import { RDSClientOptions } from "@eggjs/rds";
+import { Base } from "sdk-base";
+
+//#region src/BaseSqlMap.d.ts
+declare class BaseSqlMapGenerator {
+  private readonly tableModel;
+  private readonly logger;
+  constructor(tableModel: TableModel, logger: Logger);
+  generateAllColumns(countIf: boolean): string;
+  generateFindByPrimary(): Array<GenerateSqlMap>;
+  generateFindByIndexes(): GenerateSqlMap[];
+  generateInsert(): string;
+  generateUpdate(): string;
+  generateDelete(): string;
+  load(): Record<string, SqlMap>;
+}
+//#endregion
+//#region src/CodeGenerator.d.ts
+declare class CodeGenerator {
+  private readonly moduleDir;
+  private readonly moduleName;
+  private readonly teggPkg;
+  private readonly dalPkg;
+  constructor(options: CodeGeneratorOptions);
+  private njkEnv;
+  createNunjucksEnv(): void;
+  genCode(tplName: Templates, filePath: string, tableModel: TableModel): string;
+  generate(tableModel: TableModel): Promise<void>;
+}
+//#endregion
+//#region src/DaoLoader.d.ts
+declare class DaoLoader {
+  static loadDaos(moduleDir: string): Promise<Array<BaseDaoType$1>>;
+}
+//#endregion
+//#region src/MySqlDataSource.d.ts
+interface DataSourceOptions extends RDSClientOptions {
+  name: string;
+  initSql?: string;
+  forkDb?: boolean;
+  initRetryTimes?: number;
+  logger?: Logger;
+}
+declare class MysqlDataSource extends Base {
+  #private;
+  private client;
+  private readonly initSql;
+  readonly name: string;
+  readonly timezone?: string;
+  readonly rdsOptions: RDSClientOptions;
+  readonly forkDb?: boolean;
+  constructor(options: DataSourceOptions);
+  protected _init(): Promise<void>;
+  query<T = any>(sql: string): Promise<T>;
+  beginTransactionScope<T>(scope: () => Promise<T>): Promise<T>;
+}
+//#endregion
+//#region src/DatabaseForker.d.ts
+declare class DatabaseForker {
+  private readonly env;
+  private readonly options;
+  constructor(env: string, options: DataSourceOptions);
+  shouldFork(): boolean;
+  forkDb(moduleDir: string): Promise<void>;
+  private forkTables;
+  private doForkTable;
+  private doCreateUtDb;
+  destroy(): Promise<void>;
+}
+//#endregion
+//#region src/TableSqlMap.d.ts
+declare class TableSqlMap {
+  #private;
+  readonly name: string;
+  private readonly map;
+  private readonly blocks;
+  private readonly sqlGenerator;
+  constructor(name: string, map: Record<string, SqlMap>);
+  generate(name: string, data: object, timezone: string): string;
+  getType(name: string): SqlType;
+  getTemplateString(name: string): string;
+}
+//#endregion
+//#region src/DataSource.d.ts
+interface ExecuteSql {
+  sql: string;
+  template: string;
+  sqlType: SqlType;
+}
+declare class DataSource<T> implements DataSource$1<T> {
+  #private;
+  private readonly tableModel;
+  private readonly mysqlDataSource;
+  private readonly sqlMap;
+  constructor(tableModel: TableModel<T>, mysqlDataSource: MysqlDataSource, sqlMap: TableSqlMap);
+  /**
+   * public for aop execute to implement sql hint append
+   * @param sqlName - sql name
+   * @param data - sql data
+   */
+  generateSql(sqlName: string, data: object): Promise<ExecuteSql>;
+  count(sqlName: string, data?: any): Promise<number>;
+  execute(sqlName: string, data?: any): Promise<Array<T>>;
+  executeRaw(sqlName: string, data?: any): Promise<Array<any>>;
+  executeScalar(sqlName: string, data?: any): Promise<T | null>;
+  executeRawScalar(sqlName: string, data?: any): Promise<any | null>;
+  paginate(sqlName: string, data: any, currentPage: number, perPageCount: number): Promise<PaginateData<T>>;
+}
+//#endregion
+//#region src/NunjucksConverter.d.ts
+declare class NunjucksConverter {
+  /**
+   * 将变量 HTML 转义的逻辑改为 MySQL 防注入转义
+   *
+   * eg:
+   *
+   *   output += runtime.suppressValue(runtime.contextOrFrameLookup(context, frame, "allColumns")
+   *
+   *   转换为
+   *
+   *   output += runtime.escapeSQL.call(this, "allColumns", runtime.contextOrFrameLookup(context,  frame, "allColumns")
+   *
+   * @param {String} code 转换前的代码
+   * @return {String} 转换后的代码
+   */
+  static convertNormalVariableCode(code: string): string;
+  /**
+   * 三目运算的 MySQL 防注入转义
+   *
+   * eg:
+   *
+   *   output += runtime.suppressValue((runtime.contextOrFrameLookup(context, frame, "$gmtCreate") !== \
+   *     runtime.contextOrFrameLookup(context, frame, "undefined")?runtime.contextOrFrameLookup(context,\
+   *     frame, "$gmtCreate"):"NOW()"), env.opts.autoescape);
+   *
+   *   转换为
+   *
+   *   output += runtime.suppressValue((runtime.contextOrFrameLookup(...) != ...) ?
+   *     runtime.escapeSQL.call(this, "...", runtime.contextOrFrameLookup(...)) :
+   *     ...)
+   *
+   * @param {String} code 转换前的代码
+   * @return {String} 转换后的代码
+   */
+  static convertTernaryCode(code: string): string;
+  /**
+   * 对象的属性，如 `user.id` 防注入转义
+   *
+   * eg:
+   *   output += runtime.suppressValue(runtime.memberLookup(\
+   *     (runtime.contextOrFrameLookup(context, frame, "user")),"id"), env.opts.autoescape);
+   *
+   * 转换为
+   *
+   *   output += runtime.escapeSQL.call(this, "<...>", runtime.memberLookup(...), env.opts.autoescape);
+   *
+   * 由于 escapeSQL 中是根据 key 与预定义 block 匹配决定是否转义，而 memberLookup 的状态下总的 key 肯定不会匹配，
+   * 所以找一个绝对不会匹配的 "<...>" 传入。事实上它可以是任意一个不会被匹配的字符串，比如说 ">_<" 等。
+   *
+   * @param {String} code 转换前的代码
+   * @return {String} 转换后的代码
+   */
+  static convertNestedObjectCode(code: string): string;
+  /**
+   * For 中的 `t_xxx` 要被转义：
+   *
+   * eg:
+   *   frame.set("...", t_...);
+   *   ...
+   *   output += runtime.suppressValue(t_.., env.opts.autoscape);
+   *
+   * 转换为
+   *
+   *   output += runtime.escapeSQL.call(this, "for.t_...", t_..., env.opts.autoescape);
+   *
+   * 由于 escapeSQL 中是根据 key 与预定义 block 匹配决定是否转义，而 memberLookup 的状态下总的 key 肯定不会匹配，
+   * 所以找一个绝对不会匹配的 "for.t_..." 传入。事实上它可以是任意一个不会被匹配的字符串，比如说 ">_<" 等。
+   *
+   * @param {String} code 转换前的代码
+   * @return {String} 转换后的代码
+   */
+  static convertValueInsideFor(code: string): string;
+}
+//#endregion
+//#region src/NunjucksUtil.d.ts
+declare class NunjucksUtils {
+  static createEnv(modelName: string): nunjucks.Environment;
+  static compile(modelName: string, sqlName: string, sql: string): nunjucks.Template;
+}
+//#endregion
+//#region src/SqlGenerator.d.ts
+declare class SqlGenerator {
+  private formatComment;
+  private generateColumn;
+  private generateColumnType;
+  private generateIndex;
+  private generateTableOptions;
+  generate(tableModel: TableModel): string;
+}
+//#endregion
+//#region src/SqlMapLoader.d.ts
+declare class SqlMapLoader {
+  private readonly logger;
+  private readonly tableModel;
+  private readonly clazzExtension;
+  constructor(tableModel: TableModel, baseDaoClazz: BaseDaoType, logger: Logger);
+  load(): TableSqlMap;
+}
+//#endregion
+//#region src/SqlUtil.d.ts
+declare class SqlUtil {
+  static minify(sql: string): string;
+}
+//#endregion
+//#region src/TableModelInstanceBuilder.d.ts
+declare class TableModelInstanceBuilder {
+  constructor(tableModel: TableModel, row: Record<string, any>);
+  static buildInstance<T>(tableModel: TableModel<T>, row: Record<string, any>): any;
+  static buildRow<T extends object>(instance: T, tableModel: TableModel<T>): any;
+}
+//#endregion
+//#region src/TemplateUtil.d.ts
+declare class TemplateUtil {
+  static isSpatialType(columnModel: ColumnModel): boolean;
+  static importPath(tableModelPath: string, currentPath: string): string;
+  static dbTypeToTsType(columnType: ColumnType): string;
+  static toJson(value: any): string;
+  static toPoint(point: Point): string;
+  static toLine(val: Line): string;
+  static toPolygon(val: Polygon): string;
+  static toGeometry(val: Geometry): string;
+  static toMultiPoint(val: MultiPoint): string;
+  static toMultiLine(val: MultiLine): string;
+  static toMultiPolygon(val: MultiPolygon): string;
+  static toGeometryCollection(val: GeometryCollection): string;
+  static spatialFilter: Record<ColumnType, string>;
+  static getSpatialFilter(columnType: ColumnType): string;
+}
+//#endregion
 export { BaseSqlMapGenerator, CodeGenerator, DaoLoader, DataSource, DataSourceOptions, DatabaseForker, ExecuteSql, MysqlDataSource, NunjucksConverter, NunjucksUtils, SqlGenerator, SqlMapLoader, SqlUtil, TableModelInstanceBuilder, TableSqlMap, TemplateUtil };