Merge pull request #539 from Sanofi-IADC/feat/ARM-1357

feat: ARM-1357 add API to get versions on a project

Author: kr1shnadas

src/jira/jira.service.ts

@@ -117,7 +117,10 @@ export class JiraService {
         },
       ),
     )
-      .then((response) => response.data)
+      .then((response) => {
+        this.logger.log('Retrieving findTickets');
+        return response;
+      })
       .catch((e) => {
         this.logger.log(e, 'error:findTickets');
       });
@@ -418,6 +421,32 @@ export class JiraService {
       });
   }
 
+  /**
+   * @function findProjectVersions Service
+   * @description Returns the list of project versions.
+   * @return Promise {any}
+   */
+  async findProjectVersions(projectIdOrKey: string): Promise<AxiosResponse> {
+    this.init();
+    return firstValueFrom(
+      this.http.get(
+        `${this.baseUrl}/rest/api/3/project/${projectIdOrKey}/versions`,
+        { auth: { username: this.apiUsername, password: this.apiToken } },
+      ),
+    )
+      .then((response) => {
+        this.logger.log('Retrieving findProjectVersions');
+        return response;
+      })
+      .catch((err) => {
+        this.logger.log(err, 'error:findProjectVersions');
+        throw new HttpException(
+          `error:API findProjectVersions > ${err}`,
+          404,
+        );
+      });
+  }
+
   /**
    * @function findProjectMetadata Service
    * @description Return a the projects metadata

src/proxy-api/dto/SearchProjectVersionsQuery.ts

@@ -0,0 +1,15 @@
+import { ApiProperty } from '@nestjs/swagger';
+import {
+  IsNotEmpty, IsString,
+} from 'class-validator';
+
+export default class SearchProjectVersionsQueryDTO {
+  @ApiProperty({
+    type: String,
+    description: 'The Jira project key or Id',
+    example: '"FACTSWT" or "10000"',
+  })
+  @IsNotEmpty()
+  @IsString()
+    projectIdOrKey: string;
+}

src/proxy-api/proxy-api.controller.ts

@@ -16,10 +16,11 @@ import {
   GetSpacesParamsDTO,
   GetSpacesQueryDTO,
 } from './proxy-api.validation.dto';
-import { KonviwResults } from './proxy-api.interface';
+import { FixVersion, KonviwResults } from './proxy-api.interface';
 import SearchProjectIssueTypesWithStatusQueryDTO from './dto/SearchProjectIssueTypesWithStatusQuery';
 import GetScreenDetailsDTO from './dto/GetScreenDetailsQuery';
 import SearchProjectUsersQueryDTO from './dto/SearchProjectUsersQuery';
+import SearchProjectVersionsQueryDTO from './dto/SearchProjectVersionsQuery';
 
 @ApiTags('proxy-api')
 @Controller('api')
@@ -171,6 +172,21 @@ export class ProxyApiController {
     return this.proxyApi.getJiraUsersByQuery(queries.query, queries.startAt, queries.maxResults);
   }
 
+  /**
+   * @GET (controller) api/projects/versions
+   * @description Returns all versions in a project
+   * @return {string} 'JSON' - Returns the valid versions for a project.
+   */
+  @ApiOkResponse({
+    description: 'List project versions',
+  })
+  @Get('projects/versions')
+  async getJiraProjectVersions(
+    @Query() queries: SearchProjectVersionsQueryDTO,
+  ): Promise<FixVersion> {
+    return this.proxyApi.getJiraProjectVersions(queries.projectIdOrKey);
+  }
+
   /**
    * @GET (controller) api/spaces
    * @description Route to retrieve the Confluence spaces of a type

src/proxy-api/proxy-api.interface.ts

@@ -37,3 +37,17 @@ export interface MetadataSearch {
   next: string;
   prev: string;
 }
+
+export interface FixVersion {
+  archived: boolean;
+  id: string;
+  name: string;
+  overdue: boolean;
+  projectId: number;
+  releaseDate: string;
+  released: boolean;
+  self: string;
+  startDate: string;
+  userReleaseDate: string;
+  userStartDate: string;
+}

src/proxy-api/proxy-api.service.ts

@@ -252,17 +252,15 @@ export class ProxyApiService {
     maxResults: number,
     reader?: boolean,
   ): Promise<any> {
-    const {
-      total, issues,
-    }: any = await this.jira.findTickets(
+    const { data }: any = await this.jira.findTickets(
       server,
       jqlSearch,
       fields,
       startAt,
       maxResults,
       reader,
     );
-    const parseResults = issues.map((issue: any) => ({
+    const parseResults = data.issues.map((issue: any) => ({
       id: issue.id,
       key: issue.key,
       selfUri: issue.self,
@@ -275,7 +273,7 @@ export class ProxyApiService {
     }));
 
     const meta = {
-      totalSize: total,
+      totalSize: data.total,
       server,
     };
 
@@ -359,7 +357,6 @@ export class ProxyApiService {
    */
   async getJiraUsersByQuery(query: string, startAt: number, maxResults: number): Promise<any> {
     const { data, total }: any = await this.jira.findUsersByQuery(query, startAt, maxResults);
-    this.logger.log(data.values);
     const parseResults = data.values.map((user: any) => ({
       id: user.accountId,
       name: user.displayName,
@@ -378,6 +375,19 @@ export class ProxyApiService {
     };
   }
 
+  /**
+   * @function getJiraProjectVersions Service
+   * @description Finds users with a structured query and returns a paginated list of user details
+   * @return Promise {any}
+   * @param query {string}
+   */
+  async getJiraProjectVersions(projectIdOrKey: string): Promise<any> {
+    const { data }: any = await this.jira.findProjectVersions(projectIdOrKey);
+    return {
+      fixVersions: data,
+    };
+  }
+
   /**
    * @function getAllSpaces Service
    * @description Retrieve all spaces from a Confluence server