Merge pull request #124 from CollActionteam/119-new-fields-for-badges

add badge icon and list of crowdActionMetadata to badgeDTO

Author: MichaelSlatteryDev

src/domain/badge/entity/badge.entity.ts

@@ -1,14 +1,27 @@
 import { AwardTypeEnum, BadgeTierEnum } from '../enum';
-import { IBadge } from '../interface/badge.interface';
+import { IBadge, ICrowdActionMetaData } from '../interface/badge.interface';
 
+export class CrowdActionMetaData implements ICrowdActionMetaData {
+    readonly id: string;
+    readonly title: string;
+
+    constructor(entityLike: ICrowdActionMetaData) {
+        this.id = entityLike.id;
+        this.title = entityLike.title;
+    }
+}
 export class Badge implements IBadge {
     readonly tier: BadgeTierEnum;
     readonly awardType: AwardTypeEnum;
     readonly minimumCheckIns: number;
+    readonly icon: string;
+    readonly crowdActionMetaData?: ICrowdActionMetaData;
 
     constructor(entityLike: IBadge) {
         this.tier = entityLike.tier;
         this.awardType = entityLike.awardType;
         this.minimumCheckIns = entityLike.minimumCheckIns;
+        this.icon = entityLike.icon;
+        this.crowdActionMetaData = entityLike.metadata;
     }
 }

src/domain/badge/interface/badge.interface.ts

@@ -1,7 +1,14 @@
 import { BadgeTierEnum, AwardTypeEnum } from '../enum';
 
+export interface ICrowdActionMetaData {
+    readonly id: string;
+    readonly title: string;
+}
+
 export interface IBadge {
     readonly tier: BadgeTierEnum;
     readonly awardType: AwardTypeEnum;
     readonly minimumCheckIns: number;
+    readonly icon: string;
+    readonly metadata?: ICrowdActionMetaData;
 }

src/infrastructure/crowdaction/dto/badge.dto.ts

@@ -1,5 +1,12 @@
 import { ApiProperty } from '@nestjs/swagger';
-import { AwardTypeEnum, BadgeTierEnum, IBadge } from '@domain/badge';
+import { AwardTypeEnum, BadgeTierEnum, IBadge, ICrowdActionMetaData } from '@domain/badge';
+export class CrowdActionMetadataDTO implements ICrowdActionMetaData {
+    @ApiProperty({ name: 'id', example: '123', required: true })
+    readonly id: string;
+
+    @ApiProperty({ name: 'title', example: 'Veganuary', required: true })
+    readonly title: string;
+}
 
 export class BadgeDto implements IBadge {
     @ApiProperty({ name: 'tier', enum: BadgeTierEnum, example: BadgeTierEnum.DIAMOND, required: true })
@@ -10,4 +17,10 @@ export class BadgeDto implements IBadge {
 
     @ApiProperty({ name: 'minimumCheckIns', example: 0, required: true })
     readonly minimumCheckIns: number;
+
+    @ApiProperty({ name: 'icon', example: 'accessibility_outline', required: false })
+    readonly icon: string;
+
+    @ApiProperty({ name: 'usedByCrowdActions', type: [CrowdActionMetadataDTO], isArray: true, required: true })
+    readonly usedByCrowdActions: CrowdActionMetadataDTO[];
 }

src/infrastructure/mongo/persistence/badge.persistence.ts

@@ -1,5 +1,5 @@
 import { Prop, Schema, SchemaFactory } from '@nestjs/mongoose';
-import { AwardTypeEnum, BadgeTierEnum, IBadge } from '@domain/badge';
+import { AwardTypeEnum, BadgeTierEnum, IBadge, ICrowdActionMetaData } from '@domain/badge';
 
 @Schema({ _id: false })
 class CrowdActionBadgePersistence implements IBadge {
@@ -11,5 +11,17 @@ class CrowdActionBadgePersistence implements IBadge {
 
     @Prop({ required: true })
     readonly minimumCheckIns: number;
+
+    @Prop()
+    readonly icon: string;
+
+    @Prop({ type: { id: { type: String }, title: { type: String } } })
+    readonly usedByCrowdActions?: ICrowdActionMetaData;
+
+    @Prop()
+    readonly id: string;
+
+    @Prop()
+    readonly title: string;
 }
 export const CrowdActionBadgePersistenceSchema = SchemaFactory.createForClass(CrowdActionBadgePersistence);

src/modules/crowdaction/cqrs/tests/list-crowdactions.query.spec.ts

@@ -233,6 +233,7 @@ const CrowdActionStub: CreateCrowdActionDto = {
         {
             tier: BadgeTierEnum.BRONZE,
             awardType: AwardTypeEnum.ALL,
+            icon: 'accessibility_outline',
             minimumCheckIns: 12,
         },
     ],
@@ -256,6 +257,7 @@ const CrowdActionStub2: CreateCrowdActionDto = {
         {
             tier: BadgeTierEnum.DIAMOND,
             awardType: AwardTypeEnum.ALL,
+            icon: 'accessibility_outline',
             minimumCheckIns: 12,
         },
     ],

src/modules/crowdaction/tests/crowdaction.spec.ts

@@ -100,6 +100,7 @@ const CrowdActionStub = (): CrowdAction => {
             {
                 tier: BadgeTierEnum.BRONZE,
                 awardType: AwardTypeEnum.ALL,
+                icon: 'accessibility_outline',
                 minimumCheckIns: 12,
             },
         ],

src/modules/profile/cqrs/tests/award-badges.command.spec.ts

@@ -54,6 +54,7 @@ describe('AwardBadgesCommand', () => {
             const badge = {
                 tier: BadgeTierEnum.BRONZE,
                 awardType: AwardTypeEnum.ALL,
+                icon: 'accessibility_icon',
                 minimumCheckIns: 10,
             };