fix: issues related nested attributes in issuance process (#1194)

* fix: issues related nested attributes in issuance process

Signed-off-by: bhavanakarwade <[email protected]>

* fix: added statuscode

Signed-off-by: bhavanakarwade <[email protected]>

* fix: required field validation for request id field

Signed-off-by: bhavanakarwade <[email protected]>

---------

Signed-off-by: bhavanakarwade <[email protected]>
Signed-off-by: Sahil Kamble <[email protected]>

Author: bhavanakarwade

apps/api-gateway/src/dtos/create-schema.dto.ts

@@ -1,3 +1,4 @@
+import { ApiExtraModels, ApiProperty, ApiPropertyOptional, getSchemaPath } from '@nestjs/swagger';
 import {
   ArrayMinSize,
   IsArray,
@@ -13,11 +14,9 @@ import {
   ValidateIf,
   ValidateNested
 } from 'class-validator';
-
-import { ApiExtraModels, ApiProperty, ApiPropertyOptional, getSchemaPath } from '@nestjs/swagger';
-import { plainToClass, Transform, Type } from 'class-transformer';
-import { IsNotSQLInjection, trim } from '@credebl/common/cast.helper';
 import { IndySchemaDataType, JSONSchemaType, SchemaTypeEnum, W3CSchemaDataType } from '@credebl/enum/enum';
+import { IsNotSQLInjection, ValidateNestedStructureFields, trim } from '@credebl/common/cast.helper';
+import { Transform, Type, plainToClass } from 'class-transformer';
 
 export class W3CAttributeValue {
   @ApiProperty()
@@ -40,6 +39,7 @@ export class W3CAttributeValue {
   @IsEnum(W3CSchemaDataType, {
     message: `Schema data type must be one of [${Object.values(W3CSchemaDataType).join(', ')}]`
   })
+  @ValidateNestedStructureFields()
   schemaDataType: W3CSchemaDataType;
 
   @ApiProperty()

apps/api-gateway/src/issuance/dtos/issuance.dto.ts

@@ -13,11 +13,12 @@ import {
   IsObject,
   IsOptional,
   IsString,
-  IsUrl,
   IsUUID,
+  IsUrl,
   MaxLength,
   ValidateNested
 } from 'class-validator';
+import { AutoAccept, SchemaType, SortValue } from '@credebl/enum/enum';
 import { IsCredentialJsonLdContext, SingleOrArray } from '../utils/helper';
 import {
   IssueCredentialType,
@@ -27,7 +28,6 @@ import {
 } from '../interfaces';
 import { Transform, Type } from 'class-transformer';
 
-import { AutoAccept, SchemaType, SortValue } from '@credebl/enum/enum';
 import { SortFields } from 'apps/connection/src/enum/connection.enum';
 import { trim } from '@credebl/common/cast.helper';
 
@@ -487,6 +487,8 @@ export class OOBCredentialDtoWithEmail {
 
   imageUrl?: string;
 
+  isValidateSchema?: boolean;
+
   orgId: string;
 }
 
@@ -654,8 +656,7 @@ export class FileQuery {
 }
 
 export class RequestIdQuery {
-  @ApiPropertyOptional({ required: false })
-  @IsOptional()
+  @ApiProperty()
   @IsString({ message: 'requestId should be string' })
   @IsNotEmpty({ message: 'requestId Id is required' })
   @Transform(({ value }) => trim(value))

apps/api-gateway/src/issuance/issuance.controller.ts

@@ -33,7 +33,8 @@ import {
   ApiQuery,
   ApiExcludeEndpoint,
   ApiConsumes,
-  ApiBody
+  ApiBody,
+  ApiNotFoundResponse
 } from '@nestjs/swagger';
 import { AuthGuard } from '@nestjs/passport';
 import { ApiResponseDto } from '../dtos/apiResponse.dto';
@@ -79,6 +80,7 @@ import { IssueCredentialDto } from './dtos/multi-connection.dto';
 import { SchemaType } from '@credebl/enum/enum';
 import { CommonConstants } from '../../../../libs/common/src/common.constant';
 import { TrimStringParamPipe } from '@credebl/common/cast.helper';
+import { NotFoundErrorDto } from '../dtos/not-found-error.dto';
 @Controller()
 @UseFilters(CustomExceptionFilter)
 @ApiTags('credentials')
@@ -255,6 +257,7 @@ export class IssuanceController {
   @ApiResponse({ status: HttpStatus.OK, description: 'Success', type: ApiResponseDto })
   @ApiUnauthorizedResponse({ status: HttpStatus.UNAUTHORIZED, description: 'Unauthorized', type: UnauthorizedErrorDto })
   @ApiForbiddenResponse({ status: HttpStatus.FORBIDDEN, description: 'Forbidden', type: ForbiddenErrorDto })
+  @ApiNotFoundResponse({ status: HttpStatus.NOT_FOUND, description: 'Not Found', type: NotFoundErrorDto })
   @ApiBearerAuth()
   @Roles(OrgRoles.OWNER, OrgRoles.ADMIN, OrgRoles.ISSUER, OrgRoles.VERIFIER)
   @UseGuards(AuthGuard('jwt'), OrgRolesGuard)
@@ -287,7 +290,11 @@ export class IssuanceController {
         .status(HttpStatus.OK)
         .send(templateData.fileContent);
     } catch (error) {
-      return res.status(error.status || error.error.code || HttpStatus.INTERNAL_SERVER_ERROR).json(error.error);
+      return res
+        .status(error.statusCode || HttpStatus.INTERNAL_SERVER_ERROR)
+        .header('Content-Type', 'application/json')
+        .header('Content-Disposition', '')
+        .send(error);
     }
   }
   /**
@@ -380,7 +387,7 @@ export class IssuanceController {
         isValidateSchema
       };
 
-      const importCsvDetails = await this.issueCredentialService.uploadCSVTemplate(uploadedfileDetails);
+      const importCsvDetails = await this.issueCredentialService.uploadCSVTemplate(uploadedfileDetails, orgId);
       const finalResponse: IResponseType = {
         statusCode: HttpStatus.CREATED,
         message: ResponseMessages.issuance.success.importCSV,
@@ -743,6 +750,11 @@ export class IssuanceController {
     summary: `Issuer create a credential offer`,
     description: `Issuer creates a credential offer and sends it to the holder`
   })
+  @ApiQuery({
+    name: 'isValidateSchema',
+    type: Boolean,
+    required: false
+  })
   @ApiQuery({
     name: 'credentialType',
     enum: IssueCredentialType
@@ -763,10 +775,12 @@ export class IssuanceController {
     orgId: string,
     @Body() issueCredentialDto: IssueCredentialDto,
     @Res() res: Response,
-    @Query('credentialType') credentialType: IssueCredentialType = IssueCredentialType.INDY
+    @Query('credentialType') credentialType: IssueCredentialType = IssueCredentialType.INDY,
+    @Query('isValidateSchema') isValidateSchema: boolean = true
   ): Promise<Response> {
     issueCredentialDto.orgId = orgId;
     issueCredentialDto.credentialType = credentialType;
+    issueCredentialDto.isValidateSchema = isValidateSchema;
 
     const credOffer = issueCredentialDto?.credentialData || [];
 
@@ -832,15 +846,23 @@ export class IssuanceController {
     name: 'credentialType',
     enum: IssueCredentialType
   })
+  @ApiQuery({
+    name: 'isValidateSchema',
+    type: Boolean,
+    required: false
+  })
   async outOfBandCredentialOffer(
     @User() user: IUserRequest,
     @Body() outOfBandCredentialDto: OOBCredentialDtoWithEmail,
     @Param('orgId') orgId: string,
     @Res() res: Response,
-    @Query('credentialType') credentialType: IssueCredentialType = IssueCredentialType.INDY
+    @Query('credentialType') credentialType: IssueCredentialType = IssueCredentialType.INDY,
+    @Query('isValidateSchema') isValidateSchema: boolean = true
   ): Promise<Response> {
     outOfBandCredentialDto.orgId = orgId;
     outOfBandCredentialDto.credentialType = credentialType;
+    outOfBandCredentialDto.isValidateSchema = isValidateSchema;
+
     const credOffer = outOfBandCredentialDto?.credentialOffer || [];
     if (IssueCredentialType.INDY !== credentialType && IssueCredentialType.JSONLD !== credentialType) {
       throw new NotFoundException(ResponseMessages.issuance.error.invalidCredentialType);

apps/api-gateway/src/issuance/issuance.service.ts

@@ -49,6 +49,7 @@ export class IssuanceService extends BaseService {
       protocolVersion: issueCredentialDto.protocolVersion,
       autoAcceptCredential: issueCredentialDto.autoAcceptCredential,
       credentialType: issueCredentialDto.credentialType,
+      isValidateSchema: issueCredentialDto.isValidateSchema,
       user
     };
 
@@ -172,8 +173,8 @@ export class IssuanceService extends BaseService {
       .response;
   }
 
-  async uploadCSVTemplate(importFileDetails: UploadedFileDetails): Promise<{ response: object }> {
-    const payload = { importFileDetails };
+  async uploadCSVTemplate(importFileDetails: UploadedFileDetails, orgId: string): Promise<{ response: object }> {
+    const payload = { importFileDetails, orgId };
     return this.natsClient.sendNats(this.issuanceProxy, 'upload-csv-template', payload);
   }
 

apps/issuance/interfaces/issuance.interfaces.ts

@@ -1,10 +1,11 @@
 // eslint-disable-next-line camelcase
 import { AutoAccept, SchemaType } from '@credebl/enum/enum';
-import { IUserRequest } from '@credebl/user-request/user-request.interface';
 import { Prisma, organisation } from '@prisma/client';
+
+import { IPrettyVc } from '@credebl/common/interfaces/issuance.interface';
+import { IUserRequest } from '@credebl/user-request/user-request.interface';
 import { IUserRequestInterface } from 'apps/agent-service/src/interface/agent-service.interface';
 import { IssueCredentialType } from 'apps/api-gateway/src/issuance/interfaces';
-import { IPrettyVc } from '@credebl/common/interfaces/issuance.interface';
 
 export interface IAttributes {
   attributeName: string;
@@ -32,6 +33,7 @@ export interface IIssuance {
   willConfirm?: boolean;
   label?: string;
   credentialType: string;
+  isValidateSchema?: string;
 }
 
 interface IIndy {
@@ -178,6 +180,7 @@ export interface OutOfBandCredentialOfferPayload {
   imageUrl?: string;
   autoAcceptCredential?: string;
   credentialType?: IssueCredentialType;
+  isValidateSchema?: boolean;
 }
 
 export interface OutOfBandCredentialOffer {

apps/issuance/src/issuance.controller.ts

@@ -1,17 +1,32 @@
+import {
+  IClientDetails,
+  IIssuance,
+  IIssueCredentials,
+  IIssueCredentialsDefinitions,
+  ImportFileDetails,
+  IssueCredentialWebhookPayload,
+  OutOfBandCredentialOffer,
+  PreviewRequest,
+  TemplateDetailsInterface
+} from '../interfaces/issuance.interfaces';
+import {
+  ICredentialOfferResponse,
+  IDeletedIssuanceRecords,
+  IIssuedCredential
+} from '@credebl/common/interfaces/issuance.interface';
+
 import { Controller } from '@nestjs/common';
-import { MessagePattern } from '@nestjs/microservices';
-import { IClientDetails, IIssuance, IIssueCredentials, IIssueCredentialsDefinitions, ImportFileDetails, IssueCredentialWebhookPayload, OutOfBandCredentialOffer, PreviewRequest, TemplateDetailsInterface } from '../interfaces/issuance.interfaces';
 import { IssuanceService } from './issuance.service';
-import { ICredentialOfferResponse, IDeletedIssuanceRecords, IIssuedCredential } from '@credebl/common/interfaces/issuance.interface';
+import { MessagePattern } from '@nestjs/microservices';
 import { OOBIssueCredentialDto } from 'apps/api-gateway/src/issuance/dtos/issuance.dto';
 import { user } from '@prisma/client';
 
 @Controller()
 export class IssuanceController {
-  constructor(private readonly issuanceService: IssuanceService) { }
+  constructor(private readonly issuanceService: IssuanceService) {}
 
   @MessagePattern({ cmd: 'get-issuance-records' })
-  async getIssuanceRecordsByOrgId(payload: { orgId: string, userId: string }): Promise<number> {
+  async getIssuanceRecordsByOrgId(payload: { orgId: string; userId: string }): Promise<number> {
     const { orgId } = payload;
     return this.issuanceService.getIssuanceRecords(orgId);
   }
@@ -22,7 +37,7 @@ export class IssuanceController {
   }
 
   @MessagePattern({ cmd: 'send-credential-create-offer-oob' })
-  async sendCredentialOutOfBand(payload: OOBIssueCredentialDto): Promise<{response: object;}> { 
+  async sendCredentialOutOfBand(payload: OOBIssueCredentialDto): Promise<{ response: object }> {
     return this.issuanceService.sendCredentialOutOfBand(payload);
   }
 
@@ -38,7 +53,6 @@ export class IssuanceController {
     return this.issuanceService.getIssueCredentialsbyCredentialRecordId(user, credentialRecordId, orgId);
   }
 
-
   @MessagePattern({ cmd: 'webhook-get-issue-credential' })
   async getIssueCredentialWebhook(payload: IssueCredentialWebhookPayload): Promise<object> {
     return this.issuanceService.getIssueCredentialWebhook(payload);
@@ -52,63 +66,71 @@ export class IssuanceController {
 
   @MessagePattern({ cmd: 'download-csv-template-for-bulk-operation' })
   async downloadBulkIssuanceCSVTemplate(payload: {
-    orgId: string, templateDetails: TemplateDetailsInterface
+    orgId: string;
+    templateDetails: TemplateDetailsInterface;
   }): Promise<object> {
-    const {templateDetails} = payload;
-    return this.issuanceService.downloadBulkIssuanceCSVTemplate(templateDetails);
+    const { orgId, templateDetails } = payload;
+    return this.issuanceService.downloadBulkIssuanceCSVTemplate(orgId, templateDetails);
   }
 
   @MessagePattern({ cmd: 'upload-csv-template' })
-  async uploadCSVTemplate(payload: {
-    importFileDetails: ImportFileDetails
-  }): Promise<string> {
-    return this.issuanceService.uploadCSVTemplate(payload.importFileDetails);
+  async uploadCSVTemplate(payload: { importFileDetails: ImportFileDetails; orgId: string }): Promise<string> {
+    return this.issuanceService.uploadCSVTemplate(payload.importFileDetails, payload.orgId);
   }
 
   @MessagePattern({ cmd: 'preview-csv-details' })
-  async previewCSVDetails(payload: { requestId: string, previewFileDetails: PreviewRequest }): Promise<object> {
-    return this.issuanceService.previewFileDataForIssuance(
-      payload.requestId,
-      payload.previewFileDetails
-    );
+  async previewCSVDetails(payload: { requestId: string; previewFileDetails: PreviewRequest }): Promise<object> {
+    return this.issuanceService.previewFileDataForIssuance(payload.requestId, payload.previewFileDetails);
   }
 
   @MessagePattern({ cmd: 'issued-file-details' })
-  async issuedFiles(payload: { orgId: string, fileParameter: PreviewRequest }): Promise<object> {
-    return this.issuanceService.issuedFileDetails(
-      payload.orgId,
-      payload.fileParameter
-    );
+  async issuedFiles(payload: { orgId: string; fileParameter: PreviewRequest }): Promise<object> {
+    return this.issuanceService.issuedFileDetails(payload.orgId, payload.fileParameter);
   }
   @MessagePattern({ cmd: 'issued-file-data' })
-  async getFileDetailsByFileId(payload: { fileId: string, fileParameter: PreviewRequest }): Promise<object> {
-    return this.issuanceService.getFileDetailsByFileId(
-      payload.fileId,
-      payload.fileParameter
-    );
+  async getFileDetailsByFileId(payload: { fileId: string; fileParameter: PreviewRequest }): Promise<object> {
+    return this.issuanceService.getFileDetailsByFileId(payload.fileId, payload.fileParameter);
   }
 
-
   @MessagePattern({ cmd: 'issue-bulk-credentials' })
-  async issueBulkCredentials(payload: { requestId: string, orgId: string, clientDetails: IClientDetails, reqPayload: ImportFileDetails, isValidateSchema: boolean }): Promise<string> {
-    return this.issuanceService.issueBulkCredential(payload.requestId, payload.orgId, payload.clientDetails, payload.reqPayload, payload.isValidateSchema);
+  async issueBulkCredentials(payload: {
+    requestId: string;
+    orgId: string;
+    clientDetails: IClientDetails;
+    reqPayload: ImportFileDetails;
+    isValidateSchema: boolean;
+  }): Promise<string> {
+    return this.issuanceService.issueBulkCredential(
+      payload.requestId,
+      payload.orgId,
+      payload.clientDetails,
+      payload.reqPayload,
+      payload.isValidateSchema
+    );
   }
 
   @MessagePattern({ cmd: 'retry-bulk-credentials' })
-  async retryeBulkCredentials(payload: { fileId: string, orgId: string, clientDetails: IClientDetails, isValidateSchema?: boolean }): Promise<string> {
-    return this.issuanceService.retryBulkCredential(payload.fileId, payload.orgId, payload.clientDetails, payload.isValidateSchema);
+  async retryeBulkCredentials(payload: {
+    fileId: string;
+    orgId: string;
+    clientDetails: IClientDetails;
+    isValidateSchema?: boolean;
+  }): Promise<string> {
+    return this.issuanceService.retryBulkCredential(
+      payload.fileId,
+      payload.orgId,
+      payload.clientDetails,
+      payload.isValidateSchema
+    );
   }
 
   @MessagePattern({ cmd: 'delete-issuance-records' })
-  async deleteIssuanceRecords(payload: {orgId: string, userDetails: user}): Promise<IDeletedIssuanceRecords> {  
+  async deleteIssuanceRecords(payload: { orgId: string; userDetails: user }): Promise<IDeletedIssuanceRecords> {
     const { orgId, userDetails } = payload;
     return this.issuanceService.deleteIssuanceRecords(orgId, userDetails);
   }
   @MessagePattern({ cmd: 'issued-file-data-and-file-details' })
-  async getFileDetailsAndFileDataByFileId(payload: { fileId: string, orgId: string }): Promise<object> {
-    return this.issuanceService.getFileDetailsAndFileDataByFileId(
-      payload.fileId,
-      payload.orgId
-    );
+  async getFileDetailsAndFileDataByFileId(payload: { fileId: string; orgId: string }): Promise<object> {
+    return this.issuanceService.getFileDetailsAndFileDataByFileId(payload.fileId, payload.orgId);
   }
-}
+}