@onivoro/server-typeorm-mysql 24.14.0 → 24.16.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onivoro/server-typeorm-mysql",
-  "version": "24.14.0",
+  "version": "24.16.0",
   "type": "commonjs",
   "main": "./index.js",
   "types": "./index.d.ts",
@@ -18,5 +18,11 @@
     "reflect-metadata": "~0.2.2",
     "typeorm": "^0.3.22",
     "typeorm-naming-strategies": "~4.1.0"
-  }
+  },
+  "files": [
+    "**/*.js",
+    "**/*.d.ts",
+    "**/*.js.map",
+    "README.md"
+  ]
 }

package/jest.config.ts

@@ -1,11 +0,0 @@
-/* eslint-disable */
-export default {
-  displayName: 'lib-server-typeorm-mysql',
-  preset: '../../../jest.preset.js',
-  testEnvironment: 'node',
-  transform: {
-    '^.+\\.[tj]s$': ['ts-jest', { tsconfig: '<rootDir>/tsconfig.spec.json' }],
-  },
-  moduleFileExtensions: ['ts', 'js', 'html'],
-  coverageDirectory: '../../../coverage/libs/server/typeorm-mysql',
-};

package/project.json

@@ -1,33 +0,0 @@
-{
-  "name": "lib-server-typeorm-mysql",
-  "$schema": "../../../node_modules/nx/schemas/project-schema.json",
-  "sourceRoot": "libs/server/typeorm-mysql/src",
-  "projectType": "library",
-  "targets": {
-    "build": {
-      "executor": "@nx/js:tsc",
-      "outputs": ["{options.outputPath}"],
-      "options": {
-        "outputPath": "dist/libs/server/typeorm-mysql",
-        "main": "libs/server/typeorm-mysql/src/index.ts",
-        "tsConfig": "libs/server/typeorm-mysql/tsconfig.lib.json",
-        "assets": [
-          "libs/server/typeorm-mysql/README.md",
-          "libs/server/typeorm-mysql/package.json"
-        ],
-        "declaration": true,
-        "updateBuildableProjectPackageJsonDependencies": true,
-        "rootDir": "libs/server/typeorm-mysql/src"
-      }
-    },
-    "publish": {
-      "executor": "@nx/js:npm",
-      "outputs": [],
-      "dependsOn": ["build"],
-      "options": {
-        "packageRoot": "dist/libs/server/typeorm-mysql"
-      }
-    }
-  },
-  "tags": []
-}

package/src/index.ts

@@ -1,24 +0,0 @@
-export * from './lib/classes/type-orm-paging-repository.class';
-export * from './lib/classes/type-orm-repository.class';
-
-export * from './lib/constants/many-to-one-relation-options.constant';
-
-export * from './lib/decorators/nullable-table-column.decorator';
-export * from './lib/decorators/primary-table-column.decorator';
-export * from './lib/decorators/table-column.decorator';
-export * from './lib/decorators/table.decorator';
-
-export * from './lib/functions/data-source-config-factory.function';
-export * from './lib/functions/data-source-factory.function';
-export * from './lib/functions/generate-date-query.function';
-export * from './lib/functions/get-api-type-from-column.function';
-export * from './lib/functions/get-paging-key.function';
-export * from './lib/functions/get-skip.function';
-export * from './lib/functions/remove-falsey-keys.function';
-
-export * from './lib/types/data-source-options.interface';
-export * from './lib/types/entity-provider.interface';
-export * from './lib/types/page-params.interface';
-export * from './lib/types/paged-data.interface';
-
-export * from './lib/server-typeorm-mysql.module';

package/src/lib/classes/__snapshots__/sql-writer.class.spec.ts.snap

@@ -1,8 +0,0 @@
-// Bun Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`SqlWriter addColumn worx 1`] = `"ALTER TABLE "blah" ADD "id" character varying PRIMARY KEY "`;
-
-exports[`SqlWriter createTable worx 1`] = `
-"CREATE TABLE "blah" ("id" character varying PRIMARY KEY ,
-"active" boolean NOT NULL );"
-`;

package/src/lib/classes/type-orm-paging-repository.class.ts

@@ -1,22 +0,0 @@
-import {
-  EntityManager,
-} from 'typeorm';
-
-import { TypeOrmRepository } from './type-orm-repository.class';
-import { IPagedData } from '../types/paged-data.interface';
-import { getSkip } from '../functions/get-skip.function';
-import { removeFalseyKeys } from '../functions/remove-falsey-keys.function';
-import { getPagingKey } from '../functions/get-paging-key.function';
-import { IPageParams } from '../types/page-params.interface';
-
-export abstract class TypeOrmPagingRepository<TEntity, TEntityParams> extends TypeOrmRepository<TEntity> {
-  protected getPagingKey = getPagingKey;
-  protected getSkip = getSkip;
-  protected removeFalseyKeys = removeFalseyKeys;
-
-  constructor(entityType: any, entityManager: EntityManager) {
-    super(entityType, entityManager);
-  }
-
-  abstract getPage(pageParams: IPageParams, params: TEntityParams): Promise<IPagedData<TEntity>>;
-}

package/src/lib/classes/type-orm-repository.class.ts

@@ -1,152 +0,0 @@
-import {
-  EntityManager,
-  FindManyOptions,
-  FindOneOptions,
-  FindOptionsWhere,
-  ILike,
-  QueryRunner,
-} from 'typeorm';
-
-import { QueryDeepPartialEntity } from 'typeorm/query-builder/QueryPartialEntity';
-import { IEntityProvider } from '../types/entity-provider.interface';
-import { BadRequestException } from '@nestjs/common';
-import { ReadStream } from 'fs';
-
-export type TQueryStreamParams<TRecord = any> = {
-  query: string,
-  onData?: (stream: ReadStream, record: TRecord, count: number) => Promise<any | void>,
-  onError?: (stream: ReadStream, error: any) => Promise<any | void>,
-  onEnd?: (stream: ReadStream, count: number) => Promise<any | void>,
-};
-
-export class TypeOrmRepository<TEntity> implements IEntityProvider<
-  TEntity,
-  FindOneOptions<TEntity>,
-  FindManyOptions<TEntity>,
-  FindOptionsWhere<TEntity>,
-  QueryDeepPartialEntity<TEntity>
-> {
-  constructor(private entityType: any, public entityManager: EntityManager) { }
-
-  forTransaction(entityManager: EntityManager): TypeOrmRepository<TEntity> {
-    return {...this, entityManager};
-  }
-
-  async getMany(options: FindManyOptions<TEntity>): Promise<TEntity[]> {
-    return await (this.repo.find as any)(options);
-  }
-
-  async getManyAndCount(options: FindManyOptions<TEntity>): Promise<[TEntity[], number]> {
-    return await (this.repo.findAndCount as any)(options);
-  }
-
-  async getOne(options: FindOneOptions<TEntity>): Promise<TEntity> {
-    const results = await this.getMany(options);
-
-    if (results?.length > 1) {
-      throw new Error(`${TypeOrmRepository.prototype.getOne.name} expects only 1 result but found ${results.length} results of entity type "${this.entityType}" for criteria ${JSON.stringify(options, null, 2)}`);
-    }
-
-    return results[0];
-  }
-
-  async postOne(body: Partial<TEntity>): Promise<TEntity> {
-    return await this.insertAndReturn(body as TEntity);
-  }
-
-  async postMany(body: Partial<TEntity | undefined>[]): Promise<TEntity[]> {
-    return await this.insertAndReturnMany(body as TEntity[]);
-  }
-
-  async delete(options: FindOptionsWhere<TEntity>): Promise<void> {
-    return await (this.repo.delete as any)(options);
-  }
-
-  async softDelete(options: FindOptionsWhere<TEntity>): Promise<void> {
-    return await (this.repo.softDelete as any)(options);
-  }
-
-  async put(options: FindOptionsWhere<TEntity>, body: QueryDeepPartialEntity<TEntity>) {
-    await this.repo.save(options, body);
-  }
-
-  async patch(options: FindOptionsWhere<TEntity>, body: QueryDeepPartialEntity<TEntity>) {
-    await this.repo.update(options, body);
-  }
-
-  get repo() {
-    return this.entityManager.getRepository(this.entityType as any);
-  }
-
-  protected async insertAndReturn(entityToInsert: TEntity): Promise<TEntity> {
-    return (await this.insertAndReturnMany([entityToInsert]))[0];
-  }
-
-  protected async insertAndReturnMany(entitiesToInsert: TEntity[]): Promise<TEntity[]> {
-    const insertionResult = await this.repo
-      .createQueryBuilder()
-      .insert()
-      .values(entitiesToInsert)
-      .returning('*')
-      .execute();
-
-    const insertedEntity: TEntity[] =
-      insertionResult.generatedMaps as TEntity[];
-
-    return insertedEntity;
-  }
-
-  static async queryStream<TRecord = any>(queryRunner: QueryRunner, _: TQueryStreamParams) {
-    if (!_.query) {
-      throw new BadRequestException(`StreamingQueryRunner requires one of: {query, table}`);
-    }
-
-    let processedCount = 0;
-    const query = _.query;
-
-    try {
-      const stream = await queryRunner.stream(query);
-
-      stream.on('data', (record: TRecord) => {
-        _.onData?.(stream, record, processedCount++);
-      });
-
-      stream.on('error', (error: Error) => {
-        console.error({ detail: `Error processing stream for query "${_.query}"`, error });
-        _.onError?.(stream, error);
-      });
-
-      stream.on('end', () => {
-        console.log({ detail: `Finished processing stream for query "${_.query}"`, processedCount });
-        _.onEnd?.(stream, processedCount);
-      });
-
-      return { stream, error: null };
-    } catch (error: any) {
-      console.error({ detail: `Error processing stream for query "${_.query}"`, error });
-      return { stream: null, error };
-    }
-  }
-
-  async queryStream<TRecord = any>(_: TQueryStreamParams) {
-    const queryRunner = this.entityManager.connection.createQueryRunner();
-    return await TypeOrmRepository.queryStream<TRecord>(queryRunner, _);
-  }
-
-  buildWhereILike(filters?: Record<string, any>): FindOptionsWhere<TEntity> {
-
-    if(!filters) {
-      return {};
-    }
-
-    return Object.entries(filters || {})
-      .reduce(
-        (_, [column, filter]) => (
-          filter
-            ? { ..._, [column]: ILike(`%${filter}%`) }
-            : _
-        ),
-        {}
-      ) as any;
-  }
-}

package/src/lib/constants/many-to-one-relation-options.constant.ts

@@ -1,3 +0,0 @@
-import { RelationOptions } from "typeorm";
-
-export const manyToOneRelationOptions: RelationOptions = { cascade: true, onDelete: 'CASCADE', orphanedRowAction: 'delete', onUpdate: 'CASCADE' };

package/src/lib/decorators/nullable-table-column.decorator.ts

@@ -1,9 +0,0 @@
-import { applyDecorators } from "@nestjs/common";
-import { Column, ColumnOptions } from "typeorm";
-import { ApiPropertyOptional } from '@nestjs/swagger';
-import { getApiTypeFromColumn } from "../functions/get-api-type-from-column.function";
-
-export const NullableTableColumn = (options?: Pick<ColumnOptions, 'type'>) => {
-    const apiType = getApiTypeFromColumn(options?.type);
-    return applyDecorators(Column({ type: options?.type, nullable: true }), ApiPropertyOptional({type: apiType}));
-};

package/src/lib/decorators/primary-table-column.decorator.ts

@@ -1,9 +0,0 @@
-import { applyDecorators } from "@nestjs/common";
-import { Column, ColumnOptions } from "typeorm";
-import { ApiProperty } from '@nestjs/swagger';
-import { getApiTypeFromColumn } from "../functions/get-api-type-from-column.function";
-
-export const PrimaryTableColumn = (options?: Pick<ColumnOptions, 'type'>) => {
-    const apiType = getApiTypeFromColumn(options?.type);
-    return applyDecorators(Column({ type: options?.type, nullable: false }), ApiProperty({type: apiType}));
-};

package/src/lib/decorators/table-column.decorator.ts

@@ -1,9 +0,0 @@
-import { applyDecorators } from "@nestjs/common";
-import { Column, ColumnOptions } from "typeorm";
-import { ApiProperty } from '@nestjs/swagger';
-import { getApiTypeFromColumn } from "../functions/get-api-type-from-column.function";
-
-export const TableColumn = (options?: Pick<ColumnOptions, 'type'>) => {
-    const apiType = getApiTypeFromColumn(options?.type);
-    return applyDecorators(Column({ type: options?.type, nullable: false }), ApiProperty({type: apiType}));
-};

package/src/lib/decorators/table.decorator.ts

@@ -1,8 +0,0 @@
-import { applyDecorators } from "@nestjs/common";
-import { Entity } from "typeorm";
-import { snakeCase } from '@onivoro/isomorphic-common';
-
-export const Table = (EntityClass: { name: string }) => {
-    const tableName = snakeCase(EntityClass.name);
-    return applyDecorators(Entity(tableName));
-};

package/src/lib/functions/data-source-config-factory.function.ts

@@ -1,33 +0,0 @@
-import { SnakeNamingStrategy } from 'typeorm-naming-strategies';
-import { MysqlConnectionOptions } from 'typeorm/driver/mysql/MysqlConnectionOptions';
-import { IDataSourceOptions } from '../types/data-source-options.interface';
-
-export function dataSourceConfigFactory(
-  name: string,
-  options: IDataSourceOptions,
-  entities: any[]
-): MysqlConnectionOptions {
-
-  const {
-    ca, database, host, password, port, username, synchronize = false, logging = false
-  } = options;
-
-  const config: MysqlConnectionOptions = {
-    name,
-    type: 'mysql',
-    host,
-    port: port as any,
-    username,
-    password,
-    ssl: ca ? { ca } : undefined,
-    database,
-    synchronize,
-    logging,
-    entities,
-    subscribers: [],
-    migrations: [],
-    namingStrategy: new SnakeNamingStrategy(),
-  };
-
-  return config;
-}

package/src/lib/functions/data-source-factory.function.ts

@@ -1,10 +0,0 @@
-import { DataSource } from 'typeorm';
-import { dataSourceConfigFactory } from './data-source-config-factory.function';
-import { IDataSourceOptions } from '../types/data-source-options.interface';
-
-export const dataSourceFactory = (
-  name: string,
-  options: IDataSourceOptions,
-  entities: any[]
-) =>
-  new DataSource(dataSourceConfigFactory(name, options, entities));

package/src/lib/functions/generate-date-query.function.ts

@@ -1,20 +0,0 @@
-import { Between, FindOperator, LessThanOrEqual, MoreThanOrEqual } from "typeorm";
-
-export function generateDateQuery(
-    minDueDate: string,
-    maxDueDate: string
-): FindOperator<Date> {
-    if (minDueDate && maxDueDate) {
-        return Between(minDueDate as any, maxDueDate as any);
-    }
-
-    if (maxDueDate) {
-        return LessThanOrEqual(new Date(maxDueDate));
-    }
-
-    if (minDueDate) {
-        return MoreThanOrEqual(new Date(minDueDate));
-    }
-
-    return undefined as any;
-}

package/src/lib/functions/get-api-type-from-column.function.ts

@@ -1,14 +0,0 @@
-import { ColumnOptions } from "typeorm";
-
-export function getApiTypeFromColumn(columnType: ColumnOptions['type']) {
-    if(!columnType) {
-        return 'string';
-    }
-
-    switch (columnType) {
-        case 'boolean':
-            return columnType;
-        default:
-            return 'string';
-    }
-}

package/src/lib/functions/get-paging-key.function.ts

@@ -1,3 +0,0 @@
-export function getPagingKey(pageSize: number, skip: number, total: number) {
-  return pageSize * skip < total ? skip + 1 : undefined;
-}

package/src/lib/functions/get-skip.function.ts

@@ -1,3 +0,0 @@
-export function getSkip(pagingKey: number | string, pageSize: number) {
-  return pagingKey ? Number(pagingKey) * pageSize : 0;
-}

package/src/lib/functions/remove-falsey-keys.function.ts

@@ -1,8 +0,0 @@
-export function removeFalseyKeys<T>(obj: T) {
-  return Object.entries(obj as any)
-    .filter(([k, v]) => typeof v !== 'undefined')
-    .reduce((acc, [k, v]) => {
-      acc[k] = v;
-      return acc;
-    }, {} as any) as T;
-}

package/src/lib/server-typeorm-mysql.module.ts

@@ -1,59 +0,0 @@
-import { DynamicModule, Module, OnApplicationShutdown } from '@nestjs/common';
-import { DataSource, EntityManager } from 'typeorm';
-import { dataSourceFactory } from './functions/data-source-factory.function';
-import { IDataSourceOptions } from './types/data-source-options.interface';
-
-const dataSourceMap = new Map<string, DataSource>();
-
-@Module({})
-export class ServerTypeormMysqlModule implements OnApplicationShutdown {
-
-  async onApplicationShutdown(): Promise<void> {
-    for (let dataSourceKey in dataSourceMap.keys()) {
-      try {
-        const dataSource = dataSourceMap.get(dataSourceKey);
-        if (dataSource && dataSource.isInitialized) {
-          console.log(`destroying connection ${dataSourceKey}`);
-          await dataSource.destroy();
-        }
-      } catch (e: any) {
-        console.error(e?.message || e);
-      }
-    }
-  }
-
-  static configure(
-    injectables: any[],
-    entities: any[],
-    options: IDataSourceOptions,
-    name = 'default'
-  ): DynamicModule {
-    const providers = [
-      {
-        provide: DataSource,
-        useFactory: async () => {
-          const cachedDataSource = dataSourceMap.get(name);
-          if (!cachedDataSource) {
-            const dataSource: DataSource = dataSourceFactory(name, options, entities);
-            await dataSource.initialize();
-            dataSourceMap.set(name, dataSource);
-          }
-          return dataSourceMap.get(name);
-        },
-      },
-      {
-        provide: EntityManager,
-        useFactory: (dataSource: DataSource) => {
-          return dataSource?.manager as any;
-        },
-        inject: [DataSource]
-      },
-      ...injectables,
-    ];
-    return {
-      module: ServerTypeormMysqlModule,
-      exports: providers,
-      providers,
-    };
-  }
-}

package/src/lib/types/data-source-options.interface.ts

@@ -1,10 +0,0 @@
-export interface IDataSourceOptions {
-    database: string,
-    host: string,
-    port: string,
-    username: string,
-    password: string,
-    synchronize?: boolean,
-    logging?: boolean,
-    ca?: string,
-}

package/src/lib/types/entity-provider.interface.ts

@@ -1,9 +0,0 @@
-export interface IEntityProvider<TEntity, TFindOneOptions, TFindManyOptions, TFindOptionsWhere, TQueryDeepPartialEntity> {
-    getOne: (options: TFindOneOptions) => Promise<TEntity>;
-    getMany: (options: TFindManyOptions) => Promise<TEntity[]>;
-    postOne: (body: Partial<TEntity>) => Promise<TEntity>;
-    postMany: (body: Partial<TEntity[]>) => Promise<TEntity[]>;
-    delete: (options: TFindOptionsWhere) => Promise<void>;
-    put: (options: TFindOptionsWhere, body: TQueryDeepPartialEntity) => Promise<void>;
-    patch: (options: TFindOptionsWhere, body: TQueryDeepPartialEntity) => Promise<void>;
-}

package/src/lib/types/page-params.interface.ts

@@ -1,6 +0,0 @@
-export interface IPageParams {
-    pagingKey: number;
-    pageSize: number;
-    sortKey?: string;
-    sortDirection?: string;
-}

package/src/lib/types/paged-data.interface.ts

@@ -1,6 +0,0 @@
-export interface IPagedData<TEntity> {
-    data: TEntity[];
-    total: number;
-    pagingKey: number;
-    pageSize: number;
-}

package/tsconfig.json

@@ -1,16 +0,0 @@
-{
-  "extends": "../../../tsconfig.server.json",
-  "compilerOptions": {
-    "outDir": "../../../dist/out-tsc"
-  },
-  "files": [],
-  "include": [],
-  "references": [
-    {
-      "path": "./tsconfig.lib.json"
-    },
-    {
-      "path": "./tsconfig.spec.json"
-    }
-  ]
-}

package/tsconfig.lib.json

@@ -1,10 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "rootDir": "./src",
-    "outDir": "../../dist/libs/server/typeorm-mysql",
-    "declaration": true
-  },
-  "exclude": ["jest.config.ts", "**/*.spec.ts", "**/*.test.ts"],
-  "include": ["src/**/*.ts"]
-}

package/tsconfig.spec.json

@@ -1,21 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "types": [
-      "jest",
-      "node"
-    ]
-  },
-  "include": [
-    "jest.config.ts",
-    "**/*.test.ts",
-    "**/*.spec.ts",
-    "**/*.test.tsx",
-    "**/*.spec.tsx",
-    "**/*.test.js",
-    "**/*.spec.js",
-    "**/*.test.jsx",
-    "**/*.spec.jsx",
-    "**/*.d.ts"
-  ]
-}