feat(typeorm): upgrade typeorm to v0.3 and address breaking changes

typeorm intorduced several breaking changes in v0.3.0. this refactors the library to account for
those changes. specifically some changes to the repository interface and the removal of the ability
to fetch a custom repository.

BREAKING CHANGE: `EntityRepository` is replaced with `PolymorphicRepository`.
`connection.getCustomRepository` is replaced with `AbstractPolymorphicRepository.createRepository`.

Author: jspizziri

README.md

@@ -23,12 +23,25 @@ This has worked for my use case however it might not for others. This is an exam
 ### Extend the PolymorphicRepository
 
 ```ts
-@EntityRepository(AdvertEntity)
+import { PolymorphicRepository } from 'typeorm-polymorphic';
+
+@PolymorphicRepository(AdvertEntity)
 export class AdvertRepository extends AbstractPolymorphicRepository<
   AdvertEntity
 > {}
 ```
 
+Then, to instantiate your repository you can call:
+
+```ts
+import { AbstractPolymorphicRepository } from 'typeorm-polymorphic';
+
+const repository = AbstractPolymorphicRepository.createRepository(
+  dataSource, // where `dataSource` is a typeorm DataSource object
+  AdvertRepository,
+);
+```
+
 > The below decorators will only work when using the above abstract repository AbstractPolymorphicRepository
 
 ### Setup the entities
@@ -96,6 +109,9 @@ id | entityId | entityType
 
 Both `PolymorphicChildren` and `PolymophicParent` are treated same. Currently some of the default values are different but eventually these method should be synonyms of one another. They have different names because it helped me describe the relationship directions which could be explained as 'parent' 'child' in different ways.
 
+`PolymophicRepository` allows you to define a custom typeorm repository and then
+instantiate it later via `AbstractPolymorphicRepository.createRepository(...)`.
+
 ### Ambiguous direction
 
 Both `PolymorphicParent` and `PolymorphicChildren` accepts either an array of types or a singular type

index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package.json

@@ -38,11 +38,11 @@
     "prettier": "^2.2.1",
     "reflect-metadata": "^0.1.13",
     "ts-jest": "^26.4.4",
-    "typeorm": "^0.2.29",
+    "typeorm": "^0.3.12",
     "typescript": "^4.1.3"
   },
   "peerDependencies": {
-    "typeorm": "^0.2.29 <= ^0.2.45"
+    "typeorm": "^0.3.0"
   },
   "jest": {
     "moduleFileExtensions": [

src/__tests__/polymorphic.repository.spec.ts

@@ -1,13 +1,14 @@
-import { Connection, createConnection, Repository } from 'typeorm';
+import { DataSource, Repository } from 'typeorm';
 import { AdvertEntity } from './entities/advert.entity';
 import { UserEntity } from './entities/user.entity';
 import { config } from 'dotenv';
 import { resolve } from 'path';
 import { AdvertRepository } from './repository/advert.repository';
 import { AbstractPolymorphicRepository } from '../';
+import { MerchantEntity } from './entities/merchant.entity';
 
 describe('AbstractPolymorphicRepository', () => {
-  let connection: Connection;
+  let connection: DataSource;
 
   let userRepository: Repository<UserEntity>;
   let repository: AbstractPolymorphicRepository<AdvertEntity>;
@@ -17,20 +18,21 @@ describe('AbstractPolymorphicRepository', () => {
       path: resolve(__dirname, '.', '..', '..', '.env'),
     });
 
-    connection = await createConnection({
+    connection = new DataSource({
       type: 'mysql',
       host: process.env.TYPEORM_HOST,
       port: parseInt(process.env.TYPEORM_PORT as string, 10),
       username: process.env.TYPEORM_USERNAME,
       password: process.env.TYPEORM_PASSWORD,
-      entities: ['./*/**/*.entity.ts'],
+      entities: [UserEntity, AdvertEntity, MerchantEntity],
       synchronize: process.env.TYPEORM_SYNCHRONIZE === 'true',
       database: process.env.TYPEORM_DATABASE,
     });
+    await connection.initialize();
   });
 
   afterAll(async () => {
-    await connection.close();
+    await connection.destroy();
 
     await userRepository.createQueryBuilder().delete().execute();
     await repository.createQueryBuilder().delete().execute();
@@ -44,7 +46,10 @@ describe('AbstractPolymorphicRepository', () => {
   describe('Childen', () => {
     describe('create', () => {
       it('Can create with parent', async () => {
-        const repository = connection.getCustomRepository(AdvertRepository);
+        const repository = AbstractPolymorphicRepository.createRepository(
+          connection,
+          AdvertRepository,
+        );
 
         const user = new UserEntity();
 
@@ -59,7 +64,10 @@ describe('AbstractPolymorphicRepository', () => {
 
     describe('save', () => {
       it('Can save cascade parent', async () => {
-        const repository = connection.getCustomRepository(AdvertRepository);
+        const repository = AbstractPolymorphicRepository.createRepository(
+          connection,
+          AdvertRepository,
+        );
         const userRepository = connection.getRepository(UserEntity);
 
         const user = await userRepository.save(new UserEntity());
@@ -79,7 +87,10 @@ describe('AbstractPolymorphicRepository', () => {
       });
 
       it('Can save many with cascade parent', async () => {
-        const repository = connection.getCustomRepository(AdvertRepository);
+        const repository = AbstractPolymorphicRepository.createRepository(
+          connection,
+          AdvertRepository,
+        );
         const userRepository = connection.getRepository(UserEntity);
 
         const user = await userRepository.save(new UserEntity());
@@ -106,7 +117,10 @@ describe('AbstractPolymorphicRepository', () => {
 
     describe('findOne', () => {
       it('Can find entity with parent', async () => {
-        const repository = connection.getCustomRepository(AdvertRepository);
+        const repository = AbstractPolymorphicRepository.createRepository(
+          connection,
+          AdvertRepository,
+        );
         const userRepository = connection.getRepository(UserEntity);
 
         const user = await userRepository.save(new UserEntity());
@@ -117,7 +131,7 @@ describe('AbstractPolymorphicRepository', () => {
           }),
         );
 
-        const result = await repository.findOne(advert.id);
+        const result = await repository.findOne({ where: { id: advert.id } });
 
         expect(result).toBeInstanceOf(AdvertEntity);
         expect(result?.owner).toBeInstanceOf(UserEntity);
@@ -128,7 +142,10 @@ describe('AbstractPolymorphicRepository', () => {
 
     describe('find', () => {
       it('Can find entities with parent', async () => {
-        const repository = connection.getCustomRepository(AdvertRepository);
+        const repository = AbstractPolymorphicRepository.createRepository(
+          connection,
+          AdvertRepository,
+        );
         const userRepository = connection.getRepository(UserEntity);
 
         const user = await userRepository.save(new UserEntity());

src/__tests__/repository/advert.repository.ts

@@ -1,6 +1,6 @@
-import { EntityRepository } from 'typeorm';
+import { PolymorphicRepository } from '../../decorators';
 import { AbstractPolymorphicRepository } from '../../polymorphic.repository';
 import { AdvertEntity } from '../entities/advert.entity';
 
-@EntityRepository(AdvertEntity)
+@PolymorphicRepository(AdvertEntity)
 export class AdvertRepository extends AbstractPolymorphicRepository<AdvertEntity> {}

src/__tests__/repository/user.repository.ts

@@ -1,4 +1,6 @@
 import { AbstractPolymorphicRepository } from '../../../dist';
+import { PolymorphicRepository } from '../../decorators';
 import { UserEntity } from '../entities/user.entity';
 
+@PolymorphicRepository(UserEntity)
 export class UserRepository extends AbstractPolymorphicRepository<UserEntity> {}

src/constants.ts

@@ -1,2 +1,3 @@
 export const POLYMORPHIC_OPTIONS = 'POLYMORPHIC_OPTIONS';
 export const POLYMORPHIC_KEY_SEPARATOR = '::';
+export const POLYMORPHIC_REPOSITORY = 'POLYMORPHIC_REPOSITORY';

src/decorators.ts

@@ -1,22 +1,26 @@
-import { POLYMORPHIC_KEY_SEPARATOR, POLYMORPHIC_OPTIONS } from './constants';
+import {
+  POLYMORPHIC_KEY_SEPARATOR,
+  POLYMORPHIC_OPTIONS,
+  POLYMORPHIC_REPOSITORY,
+} from './constants';
 import {
   PolymorphicDecoratorOptionsInterface,
   PolymorphicMetadataOptionsInterface,
 } from './polymorphic.interface';
 
-const polymorphicPropertyDecorator = (
-  options: PolymorphicMetadataOptionsInterface,
-): PropertyDecorator => (target: Object, propertyKey: string) => {
-  Reflect.defineMetadata(POLYMORPHIC_OPTIONS, true, target);
-  Reflect.defineMetadata(
-    `${POLYMORPHIC_OPTIONS}${POLYMORPHIC_KEY_SEPARATOR}${propertyKey}`,
-    {
-      propertyKey,
-      ...options,
-    },
-    target,
-  );
-};
+const polymorphicPropertyDecorator =
+  (options: PolymorphicMetadataOptionsInterface): PropertyDecorator =>
+  (target: Object, propertyKey: string) => {
+    Reflect.defineMetadata(POLYMORPHIC_OPTIONS, true, target);
+    Reflect.defineMetadata(
+      `${POLYMORPHIC_OPTIONS}${POLYMORPHIC_KEY_SEPARATOR}${propertyKey}`,
+      {
+        propertyKey,
+        ...options,
+      },
+      target,
+    );
+  };
 
 export const PolymorphicChildren = (
   classType: () => Function[] | Function,
@@ -45,3 +49,14 @@ export const PolymorphicParent = (
     deleteBeforeUpdate: false,
     ...options,
   });
+
+export const PolymorphicRepository =
+  (entity: Function): ClassDecorator =>
+  (target: object, _key?: any, descriptor?: any) => {
+    if (descriptor) {
+      Reflect.defineMetadata(POLYMORPHIC_REPOSITORY, entity, descriptor.value);
+      return descriptor;
+    }
+    Reflect.defineMetadata(POLYMORPHIC_REPOSITORY, entity, target);
+    return target;
+  };