typeorm-infrastructure
v1.0.16
Published
Simple infrastructure implementation for TypeORM.
Downloads
25
Maintainers
Readme
Typeorm Infrastructure
This library provides a simple wrapper around TypeORM functions in order to provide consistent and predictable error messages, it uses Boom to generate error objects.
Installation
npm install typeorm-infrastructure --save
Usage
Step 1:
Create a TypeORM entity:
import {
Column,
CreateDateColumn,
Entity,
PrimaryGeneratedColumn,
UpdateDateColumn
} from 'typeorm';
@Entity({ name: 'hero' })
export default class Hero {
@PrimaryGeneratedColumn()
public id?: number;
@Column({ name: 'name', length: 500 })
public name: string;
@Column({ name: 'identity', length: 500 })
public identity: string;
@Column({ name: 'hometown', length: 500 })
public hometown: string;
@Column({ name: 'age' })
public age: number;
@CreateDateColumn({ name: 'created_at', type: 'timestamp with time zone' })
public createdAt?: Date;
@UpdateDateColumn({ name: 'updated_at', type: 'timestamp with time zone' })
public updatedAt?: Date;
@Column({ name: 'deleted_at', nullable: true, type: 'timestamp with time zone' })
public deletedAt?: Date;
}
Step 2:
Create a repository for the entity above:
import BaseRepository from 'grpc-typeorm-infrastructure';
import Hero from '@entities/hero.entity';
export default class HeroRepository extends BaseRepository<Hero> {
constructor() {
super(Hero.name);
}
}
Step 3:
Create a service for the entity above:
import { BaseService } from 'grpc-typeorm-infrastructure';
import Hero from '@entities/hero.entity';
export default class HeroService extends BaseService<Hero> {
constructor(heroRepository: HeroRepository) {
super(heroRepository);
}
public preSaveHook(hero: Hero): void {
// Executed before the save repository call
delete hero.id;
}
public preUpdateHook(hero: Hero) {
// Executed before the update repository call
delete hero.updatedAt;
}
public preDeleteHook(hero: Hero) {
// Executed before the delete repository call
hero.deletedAt = new Date();
}
public preResultHook(hero: Hero) {
// Executed before the result is returned
delete hero.deletedAt;
}
}
Repository API
The base repository will give you access to the following methods:
getAll(options?: FindManyOptions<T>): Promise<T[]>;
findManyByFilter(options: FindManyOptions<T>): Promise<T[]>;
findOneById(id: number): Promise<T>;
findOneByIdWithOptions(id: number, options?: FindOneOptions<T>): Promise<T>;
findManyById(idList: number[], options?: FindOneOptions<T>): Promise<T[]>;
findOneByFilter(options: FindOneOptions<T>): Promise<T>;
save(record: T, options?: SaveOptions): Promise<T>;
saveAll(
records: T[],
options?: SaveOptions,
resolveRelations?: boolean
): Promise<T[]>;
updateOneById(id: number, record: T): Promise<T>;
deleteOneById(
id: number,
findOptions?: FindOneOptions<T>,
deleteOptions?: RemoveOptions
): Promise<T>;
deleteManyById(idList: number[], deleteOptions?: RemoveOptions): Promise<T>;
findOneWithQueryBuilder(
options: ISearchQueryBuilderOptions
): Promise<T | undefined>;
findManyWithQueryBuilder(options: ISearchQueryBuilderOptions): Promise<T[]>;
delete(record: T, options?: RemoveOptions);
Service API
The base service will give you access to the following methods:
preSaveHook(entity: T): void;
preSaveHook(entity: T): void;
preUpdateHook(entity: T): void;
preDeleteHook(entity: T): void;
preResultHook(entity: T): void;
validId(id: number): boolean;
isValid(entity: T): Promise<boolean>;
findAll(): Promise<T[]>;
findAllByFilter(filter: FindManyOptions<T>): Promise<T[]>;
findOneById(id: number): Promise<T>;
findOneByFilter(filter: FindOneOptions<T>): Promise<T>;
findOneWithQueryBuilder(options: ISearchQueryBuilderOptions): Promise<T>;
findManyWithQueryBuilder(options: ISearchQueryBuilderOptions): Promise<T[]>;
search(limit: number, searchTerms: SearchTerm[]);
save(entity: T): Promise<T>;
saveAll(entities: T[]): Promise<T[]>;
update(entity: T, id: number): Promise<T>;
updateAll(entities: T[]): Promise<T[]>;
getSearchFilter(
limit: number,
searchTerms: SearchTerm[]
): ISearchQueryBuilderOptions;
delete(id: number): Promise<T>;
softDelete(id: number): Promise<T>;