Merge pull request #856 from aakashreddy-p/aakash/feat/maunal-downgrade-setup

feat: manual-downgrade,auto-downgrade plan setup SPRW-2164.

Author: itsmdasifraza

src/modules/billing/billing.module.ts

@@ -22,6 +22,10 @@ import { UserRepository } from "@src/modules/identity/repositories/user.reposito
 import { PricingService } from "@src/modules/workspace/services/pricing.repository";
 import { PricingRepository } from "@src/modules/workspace/repositories/pricing.repository";
 import { SalesEmailRepository } from "../workspace/repositories/sales-email.repository";
+import { DownGradeTeamRepository } from "./repositories/downgradeTeam.repository";
+import { DownGradeUserRepository } from "./repositories/downgradeUser.repository";
+import { DownGradeWorkspaceRepository } from "./repositories/downgradeWorkspace.repository";
+import { DownGradeService } from "./services/downgrade.service";
 
 // Try to import the Stripe module, but don't crash if it's not available
 let StripeModule: any;
@@ -48,6 +52,10 @@ export class BillingModule {
       BillingAuditRepository,
       PromoCodeRepository,
       PricingRepository,
+      DownGradeTeamRepository,
+      DownGradeUserRepository,
+      DownGradeWorkspaceRepository,
+      DownGradeService,
       BillingAuditService,
       PromoCodeService,
       PricingService,
@@ -73,6 +81,10 @@ export class BillingModule {
       BillingAuditRepository,
       BillingAuditService,
       PromoCodeService,
+      DownGradeTeamRepository,
+      DownGradeUserRepository,
+      DownGradeWorkspaceRepository,
+      DownGradeService,
       PricingService,
       PaymentEmailService,
       PaymentEmailHelper,

src/modules/billing/controllers/stripe.controller.ts

@@ -49,6 +49,7 @@ import { SalesEmailRepository } from "@src/modules/workspace/repositories/sales-
 import { ConfigService } from "@nestjs/config";
 import { TrialType } from "@src/modules/common/enum/trial.enum";
 import { PricingPlan } from "@src/modules/common/models/pricing.model";
+import { DownGradeService } from "../services/downgrade.service";
 
 // Dynamically import Stripe services
 let StripeService: any;
@@ -72,6 +73,7 @@ export class StripeController {
     private readonly pricingService: PricingService,
     private readonly configService: ConfigService,
     private readonly salesEmailRepository: SalesEmailRepository,
+    private readonly downgradeService: DownGradeService,
   ) {
     this.isStripeAvailable = !!this.stripeService;
 
@@ -295,10 +297,10 @@ export class StripeController {
         for (const planBilling of currentPlan.billing) {
           if (planBilling.providers?.stripe === createSubscriptionDto.priceId) {
             selectedPlan = currentPlan;
-            break; 
+            break;
           }
         }
-        if (selectedPlan) break; 
+        if (selectedPlan) break;
       }
       if (selectedPlan) {
         // Replace or set planName
@@ -423,6 +425,13 @@ export class StripeController {
         updateSubscriptionDto.seats,
         updateSubscriptionDto.paymentBehavior,
       );
+      if (subscription && updateSubscriptionDto?.workspaces) {
+        await this.downgradeService.addDowgradeDetails(
+          updateSubscriptionDto?.metadata?.hubId,
+          updateSubscriptionDto?.workspaces,
+          updateSubscriptionDto?.users,
+        );
+      }
 
       return subscription;
     } catch (error) {
@@ -459,12 +468,17 @@ export class StripeController {
   ): Promise<SubscriptionResponseDto> {
     try {
       this.checkStripeAvailability();
-
       const subscription = await this.stripeService.cancelSubscription(
         subscriptionId,
         false, //disables cancellation at mid cycle
       );
-
+      if (subscription) {
+        await this.downgradeService.addDowgradeDetails(
+          cancelSubscriptionDto.teamId,
+          cancelSubscriptionDto.workspaces,
+          cancelSubscriptionDto.users,
+        );
+      }
       return { subscription };
     } catch (error) {
       throw new HttpException(
@@ -509,7 +523,11 @@ export class StripeController {
         subscriptionId,
         reactivateDto.metadata,
       );
-
+      if (subscription) {
+        await this.downgradeService.removeDowngradeDetails(
+          reactivateDto.metadata?.hubId,
+        );
+      }
       return { subscription };
     } catch (error) {
       throw new HttpException(

src/modules/billing/payloads/downgrade-user.payload.ts

@@ -0,0 +1,114 @@
+import { IsNotEmpty, IsMongoId } from "class-validator";
+import { ApiProperty } from "@nestjs/swagger";
+import {
+  IsString,
+  IsOptional,
+  IsEmail,
+  IsArray,
+  ValidateNested,
+  IsBoolean,
+  IsDate,
+} from "class-validator";
+import { Type } from "class-transformer";
+import { ObjectId } from "mongodb";
+
+export class DowngradeUserDto {
+  @ApiProperty({ example: "64f03af32e420f7f68055b92" })
+  @IsMongoId()
+  @IsNotEmpty()
+  teamId: string;
+
+  @ApiProperty({ example: "64f03af32e420f7f68055b92" })
+  @IsMongoId()
+  @IsNotEmpty()
+  userId: string;
+}
+
+export class TourGuideDto {
+  @IsBoolean()
+  @IsOptional()
+  isRequestTestsNoCodeDemoCompleted?: boolean;
+
+  @IsBoolean()
+  @IsOptional()
+  isGenerateVariableDemoCompleted?: boolean;
+
+  @IsBoolean()
+  @IsOptional()
+  isRequestTestsScriptDemoCompleted?: boolean;
+}
+
+class UserWorkspaceDto {
+  @IsMongoId()
+  @IsNotEmpty()
+  workspaceId: string;
+
+  @IsString()
+  @IsNotEmpty()
+  name: string;
+
+  @IsMongoId()
+  @IsNotEmpty()
+  teamId: string;
+
+  @IsBoolean()
+  @IsOptional()
+  isNewInvite?: boolean;
+}
+
+class TeamDto {
+  @IsMongoId()
+  @IsNotEmpty()
+  id: ObjectId;
+
+  @IsString()
+  @IsNotEmpty()
+  name: string;
+
+  @IsString()
+  @IsNotEmpty()
+  role: string;
+
+  @IsBoolean()
+  @IsOptional()
+  isNewInvite?: boolean;
+
+  @IsOptional()
+  @IsDate()
+  joinedAt?: Date;
+}
+
+class DownGradeUserDto {
+  @IsString()
+  @IsOptional()
+  name?: string;
+
+  @IsEmail()
+  @IsOptional()
+  email?: string;
+
+  @IsArray()
+  @IsOptional()
+  @Type(() => TeamDto)
+  teams?: TeamDto[];
+
+  @IsArray()
+  @Type(() => UserWorkspaceDto)
+  @IsOptional()
+  @ValidateNested({ each: true })
+  workspaces?: UserWorkspaceDto[];
+}
+
+class DownGradeUserGenerateVariableDto extends DownGradeUserDto {
+  @IsArray()
+  @IsString({ each: true })
+  @Type(() => String)
+  isGenerateVariableTrial?: string[];
+}
+
+export class DownGradeUserTourGuideDto extends DownGradeUserGenerateVariableDto {
+  @IsOptional()
+  @ValidateNested()
+  @Type(() => TourGuideDto)
+  tourGuide?: TourGuideDto;
+}

src/modules/billing/payloads/stripe.payload.ts

@@ -1,4 +1,8 @@
 import { ApiProperty, ApiPropertyOptional } from "@nestjs/swagger";
+import {
+  downgradeUser,
+  downgradeWorkspace,
+} from "@src/modules/common/models/billing.model";
 import {
   IsEmail,
   IsString,
@@ -7,6 +11,8 @@ import {
   IsBoolean,
   IsNotEmpty,
   IsNumber,
+  IsArray,
+  ValidateNested,
 } from "class-validator";
 
 export class CreateCustomerDto {
@@ -199,6 +205,28 @@ export class UpdateSubscriptionDto {
   @IsNumber()
   seats?: number;
   paymentBehavior?: "default_incomplete" | "allow_incomplete";
+
+  @ApiPropertyOptional({
+    description: "List of workspaces to downgrade",
+    example: [
+      { id: "workspace-id-1", name: "Workspace One" },
+      { id: "workspace-id-2", name: "Workspace Two" },
+    ],
+  })
+  @IsOptional()
+  @IsArray()
+  workspaces?: downgradeWorkspace[];
+
+  @ApiPropertyOptional({
+    description: "List of users to downgrade",
+    example: [
+      { id: "user-id-1", email: "[email protected]" },
+      { id: "user-id-2", email: "[email protected]" },
+    ],
+  })
+  @IsOptional()
+  @IsArray()
+  users?: downgradeUser[];
 }
 
 export class CancelSubscriptionDto {
@@ -210,6 +238,26 @@ export class CancelSubscriptionDto {
   @IsOptional()
   @IsBoolean()
   cancelImmediately?: boolean;
+
+  @ApiPropertyOptional({
+    description: "team Id",
+    example: "688731d965594536e3ffdce1",
+  })
+  @IsOptional()
+  @IsString()
+  teamId?: string;
+
+  @IsOptional()
+  @IsArray()
+  workspaces?: downgradeWorkspace[];
+
+  @ApiPropertyOptional({
+    description: "List of user IDs to downgrade",
+    example: ["[email protected]"],
+  })
+  @IsOptional()
+  @IsArray()
+  users?: downgradeUser[];
 }
 
 export class ReactivateSubscriptionDto {

src/modules/billing/repositories/downgradeTeam.repository.ts

@@ -0,0 +1,33 @@
+import { Injectable, Inject } from "@nestjs/common";
+import { Collections } from "@src/modules/common/enum/database.collection.enum";
+import { Team, TeamDto } from "@src/modules/common/models/team.model";
+import { Db } from "mongodb";
+import { ObjectId, WithId } from "mongodb";
+
+/**
+ * Repository for handling promo code database operations
+ */
+@Injectable()
+export class DownGradeTeamRepository {
+  constructor(@Inject("DATABASE_CONNECTION") private db: Db) {}
+
+  async findTeamByTeamId(id: ObjectId): Promise<WithId<Team>> {
+    const teamData = await this.db
+      .collection<Team>(Collections.TEAM)
+      .findOne({ _id: id });
+    return teamData;
+  }
+
+  async updateTeamById(
+    id: ObjectId,
+    updateParams: Partial<any>,
+  ): Promise<WithId<Team>> {
+    const updatedTeamParams = {
+      $set: updateParams,
+    };
+    const responseData = await this.db
+      .collection<Team>(Collections.TEAM)
+      .findOneAndUpdate({ _id: id }, updatedTeamParams);
+    return responseData.value;
+  }
+}

src/modules/billing/repositories/downgradeUser.repository.ts

@@ -0,0 +1,41 @@
+import { Injectable, Inject } from "@nestjs/common";
+import { Db } from "mongodb";
+import { ObjectId, WithId } from "mongodb";
+import { User } from "@src/modules/common/models/user.model";
+import { Collections } from "@src/modules/common/enum/database.collection.enum";
+import { DownGradeUserTourGuideDto } from "../payloads/downgrade-user.payload";
+
+/**
+ * Repository for handling promo code database operations
+ */
+@Injectable()
+export class DownGradeUserRepository {
+  constructor(@Inject("DATABASE_CONNECTION") private db: Db) {}
+  async findUserByUserId(id: ObjectId): Promise<WithId<User>> {
+    const userData = await this.db
+      .collection<User>(Collections.USER)
+      .findOne({ _id: id });
+    return userData;
+  }
+
+  async updateUserById(
+    id: ObjectId,
+    updateParams: Partial<DownGradeUserTourGuideDto>,
+  ): Promise<WithId<User>> {
+    const updatedUserParams = {
+      $set: updateParams,
+    };
+    const responseData = await this.db
+      .collection<User>(Collections.USER)
+      .findOneAndUpdate({ _id: id }, updatedUserParams);
+    return responseData.value;
+  }
+
+  async findUsersByIdArray(IdArray: Array<ObjectId>): Promise<WithId<User>[]> {
+    const response = await this.db
+      .collection<User>(Collections.USER)
+      .find({ _id: { $in: IdArray } })
+      .toArray();
+    return response;
+  }
+}