Merge pull request #726 from prayas17/feat-Generate-Variables-Collection-Page

feat: generate variables in collection page

Author: aakashreddy-p

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

@@ -1601,6 +1601,36 @@ export class collectionController {
     return res.status(responseData.httpStatusCode).send(responseData);
   }
 
+  /**
+   * Endpoint to Generate the Variables of whole Collection using AI.
+   */
+  @Post("generate-variables/:collectionId")
+  @ApiOperation({
+    summary: "Generate Variables",
+    description:
+      "This will Generate Variables for the Collection using AI",
+  })
+  @UseGuards(JwtAuthGuard)
+  @ApiResponse({ status: 200, description: "Variables Generated Successfully" })
+  @ApiResponse({ status: 400, description: "Failed to Generate Variables" })
+  async generateVariables(
+    @Param("collectionId") collectionId: string,
+    @Body() collectionDto: Partial<CollectionRequestDto>,
+    @Res() res: FastifyReply,
+    @Req() request: ExtendedFastifyRequest,
+  ) {
+    const user = request?.user;
+    const workspaceId = collectionDto?.workspaceId
+    const collectionVariables = await this.collectionRequestService.generateVariables(
+      collectionId,
+      workspaceId,
+      user
+    );
+    const responseData = new ApiResponseService(
+      "Success",
+      HttpStatusCode.OK,
+      collectionVariables);
+  };
   /**
    * Endpoint to update all the New generated Variables in requests.
    *

src/modules/workspace/payloads/collectionRequest.payload.ts

@@ -32,6 +32,8 @@ import {
   Auth,
   KeyValue,
 } 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
@@ -921,6 +923,36 @@ export class UpdateMockResponseRatioDto {
   mockResponseRatios: MockResponseRatioDto[];
 }
 
+export class GeneratedVariablesDto {
+  @ApiProperty({
+    example: { '{{url_var1}}': 'https://example.com/api' },
+    description: 'Key-value pairs of URL variables'
+  })
+  @IsObject()
+  url: Record<string, string>;
+
+  @ApiProperty({
+    example: { '{{body_var1}}': 'someValue' },
+    description: 'Key-value pairs of body variables'
+  })
+  @IsObject()
+  body: Record<string, string>;
+
+  @ApiProperty({
+    example: { '{{query_var1}}': 'someQueryValue' },
+    description: 'Key-value pairs of query parameters'
+  })
+  @IsObject()
+  query: Record<string, string>;
+
+  @ApiProperty({
+    example: { '{{headers_var1}}': 'someHeadersValue' },
+    description: 'Key-value pairs of headers parameters'
+  })
+  @IsObject()
+  headers: Record<string, string>;
+}
+
 export class CollectionGeneratedVariableDto {
   @ApiProperty({ example: "6538e910aa77d958912371f5" })
   @IsString()