Merge branch 'development' into feat-Generate-Variables-Collection-Page

Author: itsmdasifraza

.env.example

@@ -121,4 +121,5 @@ STRIPE_SECRET_KEY=                # Stripe secret key (backend - KEEP SECURE!)
 
 # [Sparrow Admin]
 SPARROW_ADMIN_KEY=                # Sparrow admin key for privileged operations specific to Sparrow team   
-ADMIN_BASE_URL=                   # Base URL for Sparrow admin operations
+ADMIN_BASE_URL=                   # Base URL for Sparrow admin operations
+STAKEHOLDERS_EMAIL_LIST=          # Comma-separated list of sparrow admin emails

deploymentManifests/deployment.yml

@@ -340,7 +340,7 @@ spec:
               valueFrom:
                 secretKeyRef:
                   name: sparrow-api-secret
-                  key: DEEPSEEK_API_MODEL      
+                  key: DEEPSEEK_API_MODEL
             - name: DB_NAME
               valueFrom:
                 secretKeyRef:
@@ -381,6 +381,11 @@ spec:
                 secretKeyRef:
                   name: sparrow-api-secret
                   key: ADMIN_BASE_URL
+            - name: STAKEHOLDERS_EMAIL_LIST
+              valueFrom:
+                secretKeyRef:
+                  name: sparrow-api-secret
+                  key: STAKEHOLDERS_EMAIL_LIST
 
 ---
 apiVersion: v1

deploymentManifests/release-v2.yml

@@ -309,7 +309,7 @@ spec:
               valueFrom:
                 secretKeyRef:
                   name: release-api-v2-secret
-                  key: DEEPSEEK_API_MODEL      
+                  key: DEEPSEEK_API_MODEL
             - name: DB_NAME
               valueFrom:
                 secretKeyRef:
@@ -350,6 +350,11 @@ spec:
                 secretKeyRef:
                   name: release-api-v2-secret
                   key: ADMIN_BASE_URL
+            - name: STAKEHOLDERS_EMAIL_LIST
+              valueFrom:
+                secretKeyRef:
+                  name: release-api-v2-secret
+                  key: STAKEHOLDERS_EMAIL_LIST
 
 ---
 apiVersion: v1

package.json

@@ -33,7 +33,8 @@
     "start:upgrade-plan": "ts-node -r tsconfig-paths/register src/upgrade-plan.ts",
     "start:migration-mock-url": "ts-node -r tsconfig-paths/register src/migrationMockRequestUrl.ts",
     "start:migration-hub-billing": "ts-node -r tsconfig-paths/register src/migrationHubBilling.ts",
-    "start:migration-superadmin": "ts-node -r tsconfig-paths/register src/migration-superadmin.ts"
+    "start:migration-superadmin": "ts-node -r tsconfig-paths/register src/migration-superadmin.ts",
+    "start:migration-email": "ts-node -r tsconfig-paths/register src/migration-emailId.ts"
   },
   "dependencies": {
     "@anthropic-ai/sdk": "^0.54.0",
@@ -84,6 +85,7 @@
     "husky": "^8.0.3",
     "install": "^0.13.0",
     "js-yaml": "^4.1.0",
+    "json2csv": "6.0.0-alpha.2",
     "jsonwebtoken": "^9.0.2",
     "mongodb": "^5.7.0",
     "nest-access-control": "2.2.0",
@@ -117,6 +119,7 @@
     "@types/gravatar": "1.8.3",
     "@types/jest": "^29.5.3",
     "@types/js-yaml": "^4.0.7",
+    "@types/json2csv": "^5.0.7",
     "@types/jsonwebtoken": "^9.0.9",
     "@types/mime-types": "^3.0.1",
     "@types/node": "16.11.56",

pnpm-lock.yaml

@@ -98,7 +98,7 @@ export default () => ({
     conversationLimit: 30,
     conversationConatiner: process.env.AI_CONVERSATION_BLOB_CONTAINER,
     encryptionSecret: process.env.ENCRYPTION_SECRET,
-    deepseekModel: process.env.DEEPSEEK_API_MODEL
+    deepseekModel: process.env.DEEPSEEK_API_MODEL,
   },
   hubspot: {
     hubspotEnabled: process.env.HUBSPOT_INTEGRATION_ENABLED,
@@ -128,6 +128,7 @@ export default () => ({
   },
   sparrowAdmin: {
     adminKey: process.env.SPARROW_ADMIN_KEY,
+    stakeholdersEmailList: process.env.STAKEHOLDERS_EMAIL_LIST,
   },
   admin: {
     baseURL: process.env.ADMIN_BASE_URL,

src/modules/common/config/configuration.ts

@@ -9,18 +9,22 @@ interface MailOptions {
   from: string;
   to: string;
   text?: string;
-  template: string;
+  template?: string;
   context?: {
     [key: string]: any;
   };
   subject: string;
+  attachments?: {
+    filename: string;
+    content: any;
+  }[];
 }
 
 @Injectable()
 export class EmailService {
   constructor(private configService: ConfigService) {}
 
-  createTransporter() {
+  createTransporter(useTemplate = true) {
     const transporter = nodemailer.createTransport({
       host: this.configService.get("app.mailHost"),
       port: this.configService.get("app.mailPort"),
@@ -31,23 +35,25 @@ export class EmailService {
       },
     });
 
-    const handlebarOptions = {
-      viewEngine: {
-        extname: ".handlebars",
-        partialsDir: path.resolve(__dirname, "..", "..", "views", "partials"),
-        layoutsDir: path.resolve(__dirname, "..", "..", "views", "layouts"),
-        defaultLayout: "main",
-        helpers: {
-          linkedinUrl: () => this.configService.get("social.linkedinUrl"),
-          githubUrl: () => this.configService.get("social.githubUrl"),
-          discordUrl: () => this.configService.get("social.discordUrl"),
+    if (useTemplate) {
+      const handlebarOptions = {
+        viewEngine: {
+          extname: ".handlebars",
+          partialsDir: path.resolve(__dirname, "..", "..", "views", "partials"),
+          layoutsDir: path.resolve(__dirname, "..", "..", "views", "layouts"),
+          defaultLayout: "main",
+          helpers: {
+            linkedinUrl: () => this.configService.get("social.linkedinUrl"),
+            githubUrl: () => this.configService.get("social.githubUrl"),
+            discordUrl: () => this.configService.get("social.discordUrl"),
+          },
         },
-      },
-      viewPath: path.resolve(__dirname, "..", "..", "views"),
-      extName: ".handlebars",
-    };
+        viewPath: path.resolve(__dirname, "..", "..", "views"),
+        extName: ".handlebars",
+      };
 
-    transporter.use("compile", hbs(handlebarOptions));
+      transporter.use("compile", hbs(handlebarOptions));
+    }
 
     return transporter;
   }

src/modules/common/services/email.service.ts

@@ -22,7 +22,7 @@ import {
   CreateCollectionDto,
   UpdateCollectionDto,
   UpdateMockCollectionStatusDto,
-  AuthCollection
+  AuthCollection,
 } from "../payloads/collection.payload";
 import { FastifyReply } from "fastify";
 import { CollectionService } from "../services/collection.service";
@@ -32,6 +32,7 @@ import { WorkspaceService } from "../services/workspace.service";
 import {
   BranchChangeDto,
   CollectionAiRequestDto,
+  CollectionGeneratedVariableDto,
   CollectionGraphQLDto,
   CollectionMockRequestResponseDto,
   CollectionRequestDto,
@@ -168,7 +169,6 @@ export class collectionController {
     return res.status(responseData.httpStatusCode).send(responseData);
   }
 
-
   @Put(":collectionId/workspace/:workspaceId")
   @ApiOperation({
     summary: "Update A  Collections",
@@ -207,24 +207,27 @@ export class collectionController {
     return res.status(responseData.httpStatusCode).send(responseData);
   }
 
-  @Get('auth-profiles/:collectionId')
+  @Get("auth-profiles/:collectionId")
   @ApiOperation({
-    summary: 'Get all auth profiles for a collection',
-    description: 'Fetches all auth profiles stored in the given collection.',
+    summary: "Get all auth profiles for a collection",
+    description: "Fetches all auth profiles stored in the given collection.",
   })
   @UseGuards(JwtAuthGuard)
-  @ApiResponse({ status: 200, description: 'List of auth profiles returned' })
-  @ApiResponse({ status: 404, description: 'Collection not found' })
+  @ApiResponse({ status: 200, description: "List of auth profiles returned" })
+  @ApiResponse({ status: 404, description: "Collection not found" })
   async getAuthProfiles(
-    @Param('collectionId') collectionId: string,
+    @Param("collectionId") collectionId: string,
     @Res() res: FastifyReply,
     @Req() req: ExtendedFastifyRequest,
   ) {
     const user = req.user;
-    const authProfiles = await this.collectionService.getAuthProfiles(collectionId, user);
+    const authProfiles = await this.collectionService.getAuthProfiles(
+      collectionId,
+      user,
+    );
 
     const responseData = new ApiResponseService(
-      'Success',
+      "Success",
       HttpStatusCode.OK,
       authProfiles,
     );
@@ -240,9 +243,16 @@ export class collectionController {
   @UseGuards(JwtAuthGuard)
   @ApiResponse({ status: 200, description: "Auth profile Added Successfully" })
   @ApiResponse({ status: 400, description: "Adding operation Failed" })
-  async addAuthProfiles(@Body() updateCollectionDto: Partial<UpdateCollectionDto>, @Res() res: FastifyReply, @Req() request: ExtendedFastifyRequest) {
+  async addAuthProfiles(
+    @Body() updateCollectionDto: Partial<UpdateCollectionDto>,
+    @Res() res: FastifyReply,
+    @Req() request: ExtendedFastifyRequest,
+  ) {
     const user = request.user;
-    const message = await this.collectionService.addAuthProfile(updateCollectionDto, user);
+    const message = await this.collectionService.addAuthProfile(
+      updateCollectionDto,
+      user,
+    );
     const responseData = new ApiResponseService(
       "Success",
       HttpStatusCode.OK,
@@ -258,11 +268,21 @@ export class collectionController {
     description: "This will update an auth profile ",
   })
   @UseGuards(JwtAuthGuard)
-  @ApiResponse({ status: 200, description: "Auth profile Updated Successfully" })
+  @ApiResponse({
+    status: 200,
+    description: "Auth profile Updated Successfully",
+  })
   @ApiResponse({ status: 400, description: "Update operation Failed" })
-  async updateAuthProfiles(@Body() payload: AuthCollection, @Res() res: FastifyReply, @Req() request: ExtendedFastifyRequest) {
+  async updateAuthProfiles(
+    @Body() payload: AuthCollection,
+    @Res() res: FastifyReply,
+    @Req() request: ExtendedFastifyRequest,
+  ) {
     const user = request.user;
-    const message = await this.collectionService.updateAuthProfile(payload, user);
+    const message = await this.collectionService.updateAuthProfile(
+      payload,
+      user,
+    );
     const responseData = new ApiResponseService(
       "Success",
       HttpStatusCode.OK,
@@ -278,11 +298,21 @@ export class collectionController {
     description: "This will delete an auth profile ",
   })
   @UseGuards(JwtAuthGuard)
-  @ApiResponse({ status: 200, description: "Auth profile Updated Successfully" })
+  @ApiResponse({
+    status: 200,
+    description: "Auth profile Updated Successfully",
+  })
   @ApiResponse({ status: 400, description: "Deletion operation Failed" })
-  async deleteAuthProfiles(@Body() payload: AuthCollection, @Res() res: FastifyReply, @Req() request: ExtendedFastifyRequest) {
+  async deleteAuthProfiles(
+    @Body() payload: AuthCollection,
+    @Res() res: FastifyReply,
+    @Req() request: ExtendedFastifyRequest,
+  ) {
     const user = request.user;
-    const message = await this.collectionService.deleteAuthProfile(payload, user);
+    const message = await this.collectionService.deleteAuthProfile(
+      payload,
+      user,
+    );
     const responseData = new ApiResponseService(
       "Success",
       HttpStatusCode.OK,
@@ -1599,7 +1629,46 @@ export class collectionController {
     const responseData = new ApiResponseService(
       "Success",
       HttpStatusCode.OK,
-      collectionVariables,
+      collectionVariables);
+  };
+  /**
+   * Endpoint to update all the New generated Variables in requests.
+   *
+   * @param collectionId The collectionId.
+   * @param KeyValuePairs[] The collectionId.
+   * @returns The response object with status and data.
+   */
+  @Post("generate-variables/insert")
+  @ApiOperation({
+    summary: "Insert Generated Variables into Collection",
+    description:
+      "Updates each request in the collection by replacing the content field with its corresponding generated variable key.",
+  })
+  @UseGuards(JwtAuthGuard)
+  @ApiResponse({
+    status: 200,
+    description: "Generated Variables Added Successfully",
+  })
+  @ApiResponse({
+    status: 400,
+    description: "Failed to add a Generate Variables.",
+  })
+  async addGeneratedVariables(
+    @Body() content: CollectionGeneratedVariableDto,
+    @Res() res: FastifyReply,
+    @Req() request: ExtendedFastifyRequest,
+  ) {
+    const user = request.user;
+    const response = await this.collectionService.insertGeneratedVariables(
+      content.collectionId,
+      content.generatedeVariables,
+      content.workspaceId,
+      user,
+    );
+    const responseData = new ApiResponseService(
+      "Generated Variables Inserted Successfully",
+      HttpStatusCode.OK,
+      response,
     );
     return res.status(responseData.httpStatusCode).send(responseData);
   }

src/modules/workspace/controllers/collection.controller.ts

@@ -34,6 +34,8 @@ import {
 } from "@src/modules/common/models/collection.rxdb.model";
 import { IsObject } from 'class-validator';
 
+import { VariableDto } from "@src/modules/common/models/environment.model";
+
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 
 export class CollectionRequestBody {
@@ -950,3 +952,30 @@ export class GeneratedVariablesDto {
   @IsObject()
   headers: Record<string, string>;
 }
+
+export class CollectionGeneratedVariableDto {
+  @ApiProperty({ example: "6538e910aa77d958912371f5" })
+  @IsString()
+  @IsNotEmpty()
+  collectionId: string;
+
+  @ApiProperty({ example: "6538e910aa77d958912371f5" })
+  @IsString()
+  @IsNotEmpty()
+  workspaceId: string;
+
+  @ApiProperty({
+    required: true,
+    example: [
+      {
+        key: "key",
+        value: "value",
+        checked: true,
+      },
+    ],
+  })
+  @IsArray()
+  @Type(() => VariableDto)
+  @ValidateNested({ each: true })
+  generatedeVariables: VariableDto[];
+}