Merge pull request #50 from solanamonk/entity_id_column_option

fix: use a constistent name for entityId column option

Author: bashleigh

src/__tests__/entities/advert.entity.ts

@@ -18,4 +18,17 @@ export class AdvertEntity {
 
   @Column({ nullable: true })
   entityType: string;
+
+  @PolymorphicParent(() => [UserEntity, MerchantEntity], {
+    entityTypeColumn: 'creatorType',
+    entityIdColumn: 'creatorId',
+    eager: true,
+  })
+  creator: UserEntity | MerchantEntity;
+
+  @Column({ nullable: true })
+  creatorId: number;
+
+  @Column({ nullable: true })
+  creatorType: string;
 }

src/__tests__/entities/merchant.entity.ts

@@ -11,4 +11,11 @@ export class MerchantEntity {
     eager: false,
   })
   adverts: AdvertEntity[];
+
+  @PolymorphicChildren(() => AdvertEntity, {
+    entityTypeColumn: 'creatorType',
+    entityIdColumn: 'creatorId',
+    eager: false,
+  })
+  createdAdverts: AdvertEntity[];
 }

src/__tests__/entities/user.entity.ts

@@ -11,4 +11,11 @@ export class UserEntity {
     eager: false,
   })
   adverts: AdvertEntity[];
+
+  @PolymorphicChildren(() => AdvertEntity, {
+    entityTypeColumn: 'creatorType',
+    entityIdColumn: 'creatorId',
+    eager: false,
+  })
+  createdAdverts: AdvertEntity[];
 }

src/__tests__/polymorphic.repository.spec.ts

@@ -179,6 +179,31 @@ describe('AbstractPolymorphicRepository', () => {
         expect(result?.entityId).toBeNull();
         expect(result?.entityType).toBeNull();
       });
+
+      it('Can find entity with customized entity and id columns', async () => {
+        const repository = AbstractPolymorphicRepository.createRepository(
+          connection,
+          AdvertRepository,
+        );
+        const userRepository = connection.getRepository(UserEntity);
+
+        const user = await userRepository.save(new UserEntity());
+
+        const advert = await repository.save(
+          repository.create({
+            creator: user,
+          }),
+        );
+
+        const result = await repository.findOne({ where: { id: advert.id } });
+
+        expect(result).toBeInstanceOf(AdvertEntity);
+
+        expect(result?.creator).toBeInstanceOf(UserEntity);
+        expect(result?.creator.id).toBe(result?.creatorId);
+        expect(result?.creatorType).toBe(UserEntity.name);
+        expect(result?.creatorId).toBe(result?.creator.id);
+      });
     });
 
     describe('find', () => {
@@ -265,6 +290,38 @@ describe('AbstractPolymorphicRepository', () => {
         expect(result?.adverts[0].entityType).toBe(UserEntity.name);
         expect(result?.adverts[0].entityId).toBe(user.id);
       });
+
+      it('Can find parent entity with children with customized entity and id columns', async () => {
+        const repository = AbstractPolymorphicRepository.createRepository(
+          connection,
+          UserRepository,
+        );
+        const advertRepository = AbstractPolymorphicRepository.createRepository(
+          connection,
+          AdvertRepository,
+        );
+
+        const user = await repository.save(new UserEntity());
+
+        const advert = await advertRepository.save(
+          advertRepository.create({
+            creator: user,
+          }),
+        );
+
+        let result = await repository.findOne({
+          where: { id: user.id },
+        });
+
+        result = await repository.hydrateOne(result);
+
+        expect(result).toBeInstanceOf(UserEntity);
+        expect(result?.createdAdverts).toHaveLength(1);
+        expect(result?.createdAdverts[0]).toBeInstanceOf(AdvertEntity);
+        expect(result?.createdAdverts[0].id).toBe(advert.id);
+        expect(result?.createdAdverts[0].creatorType).toBe(UserEntity.name);
+        expect(result?.createdAdverts[0].creatorId).toBe(user.id);
+      });
     });
   });
 });

src/polymorphic.interface.ts

@@ -8,7 +8,7 @@ export interface PolymorphicInterface {
   hasMany: boolean;
   primaryColumn?: string;
   entityTypeColumn?: string;
-  entityTypeId?: string;
+  entityIdColumn?: string;
   eager: boolean;
   cascade: boolean;
   deleteBeforeUpdate: boolean;
@@ -31,7 +31,7 @@ export interface PolymorphicDecoratorOptionsInterface {
   cascade?: boolean;
   eager?: boolean;
   entityTypeColumn?: string;
-  entityTypeId?: string;
+  entityIdColumn?: string;
 }
 
 export type PolymorphicChildType = {

src/polymorphic.repository.ts

@@ -31,7 +31,7 @@ type PolymorphicHydrationType = {
 const entityTypeColumn = (options: PolymorphicMetadataInterface): string =>
   options.entityTypeColumn || 'entityType';
 const entityIdColumn = (options: PolymorphicMetadataInterface): string =>
-  options.entityTypeId || 'entityId';
+  options.entityIdColumn || 'entityId';
 const PrimaryColumn = (options: PolymorphicMetadataInterface): string =>
   options.primaryColumn || 'id';