@nest-omni/core 1.0.57 → 2.0.1-0

package/.history/src/common/boilerplate.polyfill_20250712170739.ts

@@ -0,0 +1,265 @@
+import 'source-map-support/register';
+
+import { compact, map } from 'lodash';
+import type { ObjectLiteral } from 'typeorm';
+import { Brackets, SelectQueryBuilder } from 'typeorm';
+
+import type { AbstractEntity } from './abstract.entity';
+import type { AbstractDto } from './dto/abstract.dto';
+import type { CreateTranslationDto } from './dto/create-translation.dto';
+import { PageDto } from './dto/page.dto';
+import { PageMetaDto } from './dto/page-meta.dto';
+import type { PageOptionsDto } from './dto/page-options.dto';
+import type { LanguageCode } from '../constants/language-code';
+import type { KeyOfType } from './types';
+import { ContextProvider } from '../providers';
+
+declare global {
+  export type Uuid = string & { _uuidBrand: undefined };
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any,@typescript-eslint/no-redundant-type-constituents
+  export type Todo = any & { _todoBrand: undefined };
+
+  // eslint-disable-next-line @typescript-eslint/naming-convention
+  interface Array<T> {
+    toDtos<Dto extends AbstractDto>(this: T[], options?: unknown): Dto[];
+
+    getByLanguage(
+      this: CreateTranslationDto[],
+      languageCode: LanguageCode,
+    ): string;
+
+    toPageDto<Dto extends AbstractDto>(
+      this: T[],
+      pageMetaDto: PageMetaDto,
+      // FIXME make option type visible from entity
+      options?: unknown,
+    ): PageDto<Dto>;
+  }
+}
+
+declare module 'typeorm' {
+  // eslint-disable-next-line @typescript-eslint/naming-convention
+  interface SelectQueryBuilder<Entity> {
+    searchByString(
+      q: string,
+      columnNames: string[],
+      options?: {
+        formStart: boolean;
+      },
+    ): this;
+
+    withTenant(tenantId?: string | number, tenantFieldName?: string): this;
+
+    paginate(
+      this: SelectQueryBuilder<Entity>,
+      pageOptionsDto: PageOptionsDto,
+      options?: Partial<{ takeAll: boolean; skipCount: boolean }>,
+    ): Promise<[Entity[], PageMetaDto]>;
+
+    leftJoinAndSelect<AliasEntity extends AbstractEntity, A extends string>(
+      this: SelectQueryBuilder<Entity>,
+      property: `${A}.${Exclude<
+        KeyOfType<AliasEntity, AbstractEntity>,
+        symbol
+      >}`,
+      alias: string,
+      condition?: string,
+      parameters?: ObjectLiteral,
+    ): this;
+
+    leftJoin<AliasEntity extends AbstractEntity, A extends string>(
+      this: SelectQueryBuilder<Entity>,
+      property: `${A}.${Exclude<
+        KeyOfType<AliasEntity, AbstractEntity>,
+        symbol
+      >}`,
+      alias: string,
+      condition?: string,
+      parameters?: ObjectLiteral,
+    ): this;
+
+    innerJoinAndSelect<AliasEntity extends AbstractEntity, A extends string>(
+      this: SelectQueryBuilder<Entity>,
+      property: `${A}.${Exclude<
+        KeyOfType<AliasEntity, AbstractEntity>,
+        symbol
+      >}`,
+      alias: string,
+      condition?: string,
+      parameters?: ObjectLiteral,
+    ): this;
+
+    innerJoin<AliasEntity extends AbstractEntity, A extends string>(
+      this: SelectQueryBuilder<Entity>,
+      property: `${A}.${Exclude<
+        KeyOfType<AliasEntity, AbstractEntity>,
+        symbol
+      >}`,
+      alias: string,
+      condition?: string,
+      parameters?: ObjectLiteral,
+    ): this;
+
+    /**
+     * 自动分页，返回所有数据（分批查询）
+     * @param pageSize 每页大小，默认1000
+     * @returns Promise<Entity[]>
+     */
+    autoPaginate(
+      this: SelectQueryBuilder<Entity>,
+      pageSize?: number,
+    ): Promise<Entity[]>;
+
+    /**
+     * 通过异步生成器迭代QueryBuilder结果
+     * @param batchSize 每批大小，默认1000
+     * @returns AsyncGenerator<Entity, void, unknown>
+     */
+    iterate(
+      this: SelectQueryBuilder<Entity>,
+      batchSize?: number,
+    ): AsyncGenerator<Entity, void, unknown>;
+  }
+}
+
+Array.prototype.toDtos = function <
+  Entity extends AbstractEntity<Dto>,
+  Dto extends AbstractDto,
+>(options?: unknown): Dto[] {
+  return compact(
+    map<Entity, Dto>(this as Entity[], (item) => item.toDto(options as never)),
+  );
+};
+
+Array.prototype.getByLanguage = function (languageCode: LanguageCode): string {
+  // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+  return this.find((translation) => languageCode === translation.languageCode)!
+    .text;
+};
+
+Array.prototype.toPageDto = function (
+  pageMetaDto: PageMetaDto,
+  options?: unknown,
+) {
+  return new PageDto(this.toDtos(options), pageMetaDto);
+};
+
+SelectQueryBuilder.prototype.searchByString = function (
+  q,
+  columnNames,
+  options,
+) {
+  if (!q) {
+    return this;
+  }
+
+  this.andWhere(
+    new Brackets((qb) => {
+      for (const item of columnNames) {
+        qb.orWhere(`${item} ILIKE :q`);
+      }
+    }),
+  );
+
+  if (options?.formStart) {
+    this.setParameter('q', `${q}%`);
+  } else {
+    this.setParameter('q', `%${q}%`);
+  }
+
+  return this;
+};
+
+SelectQueryBuilder.prototype.paginate = async function (
+  pageOptionsDto,
+  options,
+) {
+  if (options?.takeAll) {
+    // 自动分页，返回所有数据和总数
+    let page = 0;
+    const all: any[] = [];
+    let batch: any[];
+    do {
+      batch = await this.clone()
+        .skip(page * pageOptionsDto.pageSize)
+        .take(pageOptionsDto.pageSize)
+        .getMany();
+      all.push(...batch);
+      page++;
+    } while (batch.length === pageOptionsDto.pageSize);
+    const itemCount = all.length;
+    const pageMetaDto = new PageMetaDto({ itemCount, pageOptionsDto });
+    return [all, pageMetaDto];
+  } else {
+    this.skip(pageOptionsDto.skip).take(pageOptionsDto.pageSize);
+    const entities = await this.getMany();
+    let itemCount = -1;
+    if (!options?.skipCount) {
+      itemCount = await this.getCount();
+    }
+    const pageMetaDto = new PageMetaDto({
+      itemCount,
+      pageOptionsDto,
+    });
+    return [entities, pageMetaDto];
+  }
+};
+
+SelectQueryBuilder.prototype.withTenant = function (
+  tenantId?: number | string,
+  tenantFieldName: string = 'tenantId',
+) {
+  if (!tenantId) {
+    tenantId = ContextProvider.getTenantId();
+  }
+
+  if (this.expressionMap.mainAlias.hasMetadata) {
+    const entityMetadata = this.expressionMap.mainAlias.metadata;
+    const columnName = entityMetadata.columns.find(
+      (column: any) => column.propertyName === tenantFieldName,
+    )?.databaseName;
+
+    if (columnName) {
+      return this.andWhere(`${this.alias}.${columnName} = :tenantId`, {
+        tenantId,
+      });
+    }
+  }
+
+  return this;
+};
+
+SelectQueryBuilder.prototype.autoPaginate = async function (pageSize = 1000) {
+  let page = 0;
+  let hasMore = true;
+  const all: any[] = [];
+  while (hasMore) {
+    const batch = await this.clone().skip(page * pageSize).take(pageSize).getMany();
+    all.push(...batch);
+    if (batch.length < pageSize) {
+      hasMore = false;
+    } else {
+      page++;
+    }
+  }
+  return all;
+};
+
+SelectQueryBuilder.prototype.iterate = async function* (batchSize = 1000) {
+  let page = 0;
+  let hasMore = true;
+  while (hasMore) {
+    const batch = await this.clone()
+      .skip(page * batchSize)
+      .take(batchSize)
+      .getMany();
+    for (const item of batch) {
+      yield item;
+    }
+    if (batch.length < batchSize) {
+      hasMore = false;
+    } else {
+      page++;
+    }
+  }
+};

package/.history/src/common/boilerplate.polyfill_20250712170801.ts

@@ -0,0 +1,291 @@
+import 'source-map-support/register';
+
+import { compact, map } from 'lodash';
+import type { ObjectLiteral } from 'typeorm';
+import { Brackets, SelectQueryBuilder } from 'typeorm';
+
+import type { AbstractEntity } from './abstract.entity';
+import type { AbstractDto } from './dto/abstract.dto';
+import type { CreateTranslationDto } from './dto/create-translation.dto';
+import { PageDto } from './dto/page.dto';
+import { PageMetaDto } from './dto/page-meta.dto';
+import type { PageOptionsDto } from './dto/page-options.dto';
+import type { LanguageCode } from '../constants/language-code';
+import type { KeyOfType } from './types';
+import { ContextProvider } from '../providers';
+
+declare global {
+  export type Uuid = string & { _uuidBrand: undefined };
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any,@typescript-eslint/no-redundant-type-constituents
+  export type Todo = any & { _todoBrand: undefined };
+
+  // eslint-disable-next-line @typescript-eslint/naming-convention
+  interface Array<T> {
+    toDtos<Dto extends AbstractDto>(this: T[], options?: unknown): Dto[];
+
+    getByLanguage(
+      this: CreateTranslationDto[],
+      languageCode: LanguageCode,
+    ): string;
+
+    toPageDto<Dto extends AbstractDto>(
+      this: T[],
+      pageMetaDto: PageMetaDto,
+      // FIXME make option type visible from entity
+      options?: unknown,
+    ): PageDto<Dto>;
+  }
+}
+
+declare module 'typeorm' {
+  // eslint-disable-next-line @typescript-eslint/naming-convention
+  interface SelectQueryBuilder<Entity> {
+    searchByString(
+      q: string,
+      columnNames: string[],
+      options?: {
+        formStart: boolean;
+      },
+    ): this;
+
+    withTenant(tenantId?: string | number, tenantFieldName?: string): this;
+
+    paginate(
+      this: SelectQueryBuilder<Entity>,
+      pageOptionsDto: PageOptionsDto,
+      options?: Partial<{ takeAll: boolean; skipCount: boolean }>,
+    ): Promise<[Entity[], PageMetaDto]>;
+
+    leftJoinAndSelect<AliasEntity extends AbstractEntity, A extends string>(
+      this: SelectQueryBuilder<Entity>,
+      property: `${A}.${Exclude<
+        KeyOfType<AliasEntity, AbstractEntity>,
+        symbol
+      >}`,
+      alias: string,
+      condition?: string,
+      parameters?: ObjectLiteral,
+    ): this;
+
+    leftJoin<AliasEntity extends AbstractEntity, A extends string>(
+      this: SelectQueryBuilder<Entity>,
+      property: `${A}.${Exclude<
+        KeyOfType<AliasEntity, AbstractEntity>,
+        symbol
+      >}`,
+      alias: string,
+      condition?: string,
+      parameters?: ObjectLiteral,
+    ): this;
+
+    innerJoinAndSelect<AliasEntity extends AbstractEntity, A extends string>(
+      this: SelectQueryBuilder<Entity>,
+      property: `${A}.${Exclude<
+        KeyOfType<AliasEntity, AbstractEntity>,
+        symbol
+      >}`,
+      alias: string,
+      condition?: string,
+      parameters?: ObjectLiteral,
+    ): this;
+
+    innerJoin<AliasEntity extends AbstractEntity, A extends string>(
+      this: SelectQueryBuilder<Entity>,
+      property: `${A}.${Exclude<
+        KeyOfType<AliasEntity, AbstractEntity>,
+        symbol
+      >}`,
+      alias: string,
+      condition?: string,
+      parameters?: ObjectLiteral,
+    ): this;
+
+    /**
+     * 自动分页，返回所有数据（分批查询）
+     * @param pageSize 每页大小，默认1000
+     * @returns Promise<Entity[]>
+     */
+    autoPaginate(
+      this: SelectQueryBuilder<Entity>,
+      pageSize?: number,
+    ): Promise<Entity[]>;
+
+    /**
+     * 通过异步生成器迭代QueryBuilder结果
+     * @param batchSize 每批大小，默认1000
+     * @returns AsyncGenerator<Entity, void, unknown>
+     */
+    iterate(
+      this: SelectQueryBuilder<Entity>,
+      batchSize?: number,
+    ): AsyncGenerator<Entity, void, unknown>;
+
+    /**
+     * 通过callback处理每个item，无需外部循环
+     * @param callback 处理函数
+     * @param batchSize 每批大小，默认1000
+     * @returns Promise<void>
+     */
+    iterate(
+      this: SelectQueryBuilder<Entity>,
+      callback: (item: Entity) => Promise<void> | void,
+      batchSize?: number,
+    ): Promise<void>;
+  }
+}
+
+Array.prototype.toDtos = function <
+  Entity extends AbstractEntity<Dto>,
+  Dto extends AbstractDto,
+>(options?: unknown): Dto[] {
+  return compact(
+    map<Entity, Dto>(this as Entity[], (item) => item.toDto(options as never)),
+  );
+};
+
+Array.prototype.getByLanguage = function (languageCode: LanguageCode): string {
+  // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+  return this.find((translation) => languageCode === translation.languageCode)!
+    .text;
+};
+
+Array.prototype.toPageDto = function (
+  pageMetaDto: PageMetaDto,
+  options?: unknown,
+) {
+  return new PageDto(this.toDtos(options), pageMetaDto);
+};
+
+SelectQueryBuilder.prototype.searchByString = function (
+  q,
+  columnNames,
+  options,
+) {
+  if (!q) {
+    return this;
+  }
+
+  this.andWhere(
+    new Brackets((qb) => {
+      for (const item of columnNames) {
+        qb.orWhere(`${item} ILIKE :q`);
+      }
+    }),
+  );
+
+  if (options?.formStart) {
+    this.setParameter('q', `${q}%`);
+  } else {
+    this.setParameter('q', `%${q}%`);
+  }
+
+  return this;
+};
+
+SelectQueryBuilder.prototype.paginate = async function (
+  pageOptionsDto,
+  options,
+) {
+  if (options?.takeAll) {
+    // 自动分页，返回所有数据和总数
+    let page = 0;
+    const all: any[] = [];
+    let batch: any[];
+    do {
+      batch = await this.clone()
+        .skip(page * pageOptionsDto.pageSize)
+        .take(pageOptionsDto.pageSize)
+        .getMany();
+      all.push(...batch);
+      page++;
+    } while (batch.length === pageOptionsDto.pageSize);
+    const itemCount = all.length;
+    const pageMetaDto = new PageMetaDto({ itemCount, pageOptionsDto });
+    return [all, pageMetaDto];
+  } else {
+    this.skip(pageOptionsDto.skip).take(pageOptionsDto.pageSize);
+    const entities = await this.getMany();
+    let itemCount = -1;
+    if (!options?.skipCount) {
+      itemCount = await this.getCount();
+    }
+    const pageMetaDto = new PageMetaDto({
+      itemCount,
+      pageOptionsDto,
+    });
+    return [entities, pageMetaDto];
+  }
+};
+
+SelectQueryBuilder.prototype.withTenant = function (
+  tenantId?: number | string,
+  tenantFieldName: string = 'tenantId',
+) {
+  if (!tenantId) {
+    tenantId = ContextProvider.getTenantId();
+  }
+
+  if (this.expressionMap.mainAlias.hasMetadata) {
+    const entityMetadata = this.expressionMap.mainAlias.metadata;
+    const columnName = entityMetadata.columns.find(
+      (column: any) => column.propertyName === tenantFieldName,
+    )?.databaseName;
+
+    if (columnName) {
+      return this.andWhere(`${this.alias}.${columnName} = :tenantId`, {
+        tenantId,
+      });
+    }
+  }
+
+  return this;
+};
+
+SelectQueryBuilder.prototype.autoPaginate = async function (pageSize = 1000) {
+  let page = 0;
+  let hasMore = true;
+  const all: any[] = [];
+  while (hasMore) {
+    const batch = await this.clone().skip(page * pageSize).take(pageSize).getMany();
+    all.push(...batch);
+    if (batch.length < pageSize) {
+      hasMore = false;
+    } else {
+      page++;
+    }
+  }
+  return all;
+};
+
+SelectQueryBuilder.prototype.iterate = async function* (callbackOrBatchSize?: any, batchSize?: number) {
+  // 支持 iterate(batchSize) 或 iterate(callback, batchSize)
+  let callback: ((item: any) => Promise<void> | void) | undefined;
+  let realBatchSize = 1000;
+  if (typeof callbackOrBatchSize === 'function') {
+    callback = callbackOrBatchSize;
+    if (typeof batchSize === 'number') realBatchSize = batchSize;
+  } else if (typeof callbackOrBatchSize === 'number') {
+    realBatchSize = callbackOrBatchSize;
+  }
+
+  let page = 0;
+  let hasMore = true;
+  while (hasMore) {
+    const batch = await this.clone()
+      .skip(page * realBatchSize)
+      .take(realBatchSize)
+      .getMany();
+    for (const item of batch) {
+      if (callback) {
+        await callback(item);
+      } else {
+        yield item;
+      }
+    }
+    if (batch.length < realBatchSize) {
+      hasMore = false;
+    } else {
+      page++;
+    }
+  }
+};