Custom repository Error

[hellraisercenobit]

With typeorm we can use custom repository to override default one to add extra methods.

For example:

@Component()
@EntityRepository(Jwt)
export class JwtRepository extends Repository<Jwt> {

}

After we juste have to inject it inside controller/model/service etc... like this:

  constructor(
    @OrmRepository('connectionName')
    private readonly jwtRepository: jwtRepository,

But only InjectRepository decorator is available on nestjs, so if we try to inject repo into a service:

@Component()
export class MyService {
  constructor(
    @InjectRepository(Jwt)
    private readonly jwtRepository: JwtRepository,

We got this error for any repo function:

Cannot read property 'findOne' of undefined
    at JwtRepository.Repository.findOne

How it is possible to use custom repo?

[BrunnerLivio]

After hours of Googling, I finally found a workaround. The solution is still pretty elegant in my opinion, but this should actually be supported out of the box.

The workaround I use, is using a provider.

My image.repository.ts

/**
 * The image repository represents the
 * interface between the appliaction image entity
 * and the database.
 */
@EntityRepository(Image)
export class ImageRepository extends Repository<Image> {
    /**
     * Finds all images and applies the given pagination
     * options
     * @param pagination The pagination options
     */
    async findAll(pagination: PaginationOptionsDto): Promise<[Image[], number]> {
        // Get Images with the pagination options applied
        // from the database.
        return await this
            .createQueryBuilder('image')
            .offset(pagination.offset)
            .limit(pagination.limit)
            .getManyAndCount();
    }
}

export const ImageRepositoryProvider = {
    provide: 'ImageRepository',
    useFactory: (connection: Connection) => connection.getCustomRepository(ImageRepository),
    inject: [Connection]
};

In the module, simply inject the provider.

E.g.
image.module.ts:

import { ImageRepositoryProvider } from './image.repository';

@Module({
  imports: [
    TypeOrmModule.forFeature([Image])
  ],
  controllers: [ImageController],
  components: [
    ImageRepositoryProvider
  ],
})
/**
 * The Image module, which bundles all
 * operational or processable image related
 * modules, controllers and components
 */
export class ImageModule { }

Now using @Inject('ImageRepository'), you can inject it into your services etc.

[hellraisercenobit]

oh yeah :) thx a lot @BrunnerLivio ! i'll try it soon to give you my feedback.

[hellraisercenobit]

@BrunnerLivio
Working like a charm!
Thx man!
Maybe it should be documented somewhere to avoid useless issues.

[kamilmysliwiec]

This feature will be available in the nearest release (here's a pull request #18)

[shusson]

@kamilmysliwiec this indicates that we shouldn't be creating services from custom repositories, especially if you want to use transactions. Thoughts?

[basvdijk]

@kamilmysliwiec What would be the correct use of this feature? Do you have an example?

[theduke]

@kamilmysliwiec yeah some documentation would be appreciated

[regniblod]

@kamilmysliwiec +1 for documentation.