feat: add credentials module to credential manager

apps/credential-manager/src/application.ts

@@ -13,6 +13,7 @@ import { natsConfig } from './config/nats.config.js';
 import { validationSchema } from './config/validation.js';
 import { CredentialOffersModule } from './credential-offers/credential-offers.module.js';
 import { CredentialRequestsModule } from './credential-requests/credential-requests.module.js';
+import { CredentialsModule } from './credentials/credentials.module.js';
 
 @Module({
   imports: [
@@ -68,11 +69,13 @@ import { CredentialRequestsModule } from './credential-requests/credential-reque
       },
     }),
 
+    CredentialsModule,
     CredentialOffersModule,
     CredentialRequestsModule,
 
     RouterModule.register([
       { module: HealthModule, path: '/health' },
+      { module: CredentialsModule, path: '/credentials' },
       { module: CredentialOffersModule, path: '/credential-offers' },
       { module: CredentialRequestsModule, path: '/credential-requests' },
     ]),

apps/credential-manager/src/credentials/__tests__/credentials.controller.spec.ts

+import type {
+  EventAnonCredsCredentialsDeleteById,
+  EventAnonCredsCredentialsGetAll,
+  EventAnonCredsCredentialsGetById,
+} from '@ocm/shared';
+
+import { Test } from '@nestjs/testing';
+import { Subject, of, takeUntil } from 'rxjs';
+
+import { NATS_CLIENT } from '../../common/constants.js';
+import { CredentialsController } from '../credentials.controller.js';
+import { CredentialsService } from '../credentials.service.js';
+
+describe('CredentialsController', () => {
+  const natsClientMock = {};
+
+  let controller: CredentialsController;
+  let service: CredentialsService;
+
+  beforeEach(async () => {
+    const moduleRef = await Test.createTestingModule({
+      controllers: [CredentialsController],
+      providers: [
+        { provide: NATS_CLIENT, useValue: natsClientMock },
+        CredentialsService,
+      ],
+    }).compile();
+
+    controller = moduleRef.get<CredentialsController>(CredentialsController);
+    service = moduleRef.get<CredentialsService>(CredentialsService);
+  });
+
+  describe('find', () => {
+    it('should return a list of credentials', (done) => {
+      const unsubscribe$ = new Subject<void>();
+      const tenantId = 'exampleTenantId';
+      const expectedResult: EventAnonCredsCredentialsGetAll['data'] = [];
+
+      jest
+        .spyOn(service, 'find')
+        .mockImplementationOnce(() => of(expectedResult));
+
+      controller
+        .find({ tenantId })
+        .pipe(takeUntil(unsubscribe$))
+        .subscribe((result) => {
+          expect(result).toStrictEqual(expectedResult);
+
+          unsubscribe$.next();
+          unsubscribe$.complete();
+
+          done();
+        });
+    });
+  });
+
+  describe('getById', () => {
+    it('should return a credential', (done) => {
+      const unsubscribe$ = new Subject<void>();
+      const tenantId = 'exampleTenantId';
+      const credentialRecordId = 'exampleCredentialRecordId';
+      const expectedResult = {} as EventAnonCredsCredentialsGetById['data'];
+
+      jest
+        .spyOn(service, 'get')
+        .mockImplementationOnce(() => of(expectedResult));
+
+      controller
+        .get({ credentialRecordId }, { tenantId })
+        .pipe(takeUntil(unsubscribe$))
+        .subscribe((result) => {
+          expect(result).toStrictEqual(expectedResult);
+
+          unsubscribe$.next();
+          unsubscribe$.complete();
+
+          done();
+        });
+    });
+  });
+
+  describe('delete', () => {
+    it('should delete a credential', (done) => {
+      const unsubscribe$ = new Subject<void>();
+      const tenantId = 'exampleTenantId';
+      const credentialRecordId = 'exampleCredentialRecordId';
+      const expectedResult = {} as EventAnonCredsCredentialsDeleteById['data'];
+
+      jest
+        .spyOn(service, 'delete')
+        .mockImplementationOnce(() => of(expectedResult));
+
+      controller
+        .delete({ credentialRecordId }, { tenantId })
+        .pipe(takeUntil(unsubscribe$))
+        .subscribe((result) => {
+          expect(result).toStrictEqual(expectedResult);
+
+          unsubscribe$.next();
+          unsubscribe$.complete();
+
+          done();
+        });
+    });
+  });
+});

apps/credential-manager/src/credentials/__tests__/credentials.module.spec.ts

+import { ClientsModule } from '@nestjs/microservices';
+import { Test } from '@nestjs/testing';
+
+import { NATS_CLIENT } from '../../common/constants.js';
+import { CredentialsController } from '../credentials.controller.js';
+import { CredentialsModule } from '../credentials.module.js';
+import { CredentialsService } from '../credentials.service.js';
+
+describe('CredentialsModule', () => {
+  let credentialsController: CredentialsController;
+  let credentialsService: CredentialsService;
+
+  beforeEach(async () => {
+    const moduleRef = await Test.createTestingModule({
+      imports: [
+        ClientsModule.registerAsync({
+          isGlobal: true,
+          clients: [{ name: NATS_CLIENT, useFactory: () => ({}) }],
+        }),
+        CredentialsModule,
+      ],
+    }).compile();
+
+    credentialsController = moduleRef.get<CredentialsController>(
+      CredentialsController,
+    );
+    credentialsService = moduleRef.get<CredentialsService>(CredentialsService);
+  });
+
+  it('should be defined', () => {
+    expect(credentialsController).toBeDefined();
+    expect(credentialsController).toBeInstanceOf(CredentialsController);
+
+    expect(credentialsService).toBeDefined();
+    expect(credentialsService).toBeInstanceOf(CredentialsService);
+  });
+});

apps/credential-manager/src/credentials/__tests__/credentials.service.spec.ts

+import type { TestingModule } from '@nestjs/testing';
+
+import { Test } from '@nestjs/testing';
+import {
+  EventAnonCredsCredentialsDeleteById,
+  EventAnonCredsCredentialsGetAll,
+  EventAnonCredsCredentialsGetById,
+} from '@ocm/shared';
+import { Subject, of, takeUntil } from 'rxjs';
+
+import { NATS_CLIENT } from '../../common/constants.js';
+import { CredentialsService } from '../credentials.service.js';
+
+describe('CredentialsService', () => {
+  const natsClientMock = { send: jest.fn() };
+  let service: CredentialsService;
+
+  beforeEach(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      providers: [
+        { provide: NATS_CLIENT, useValue: natsClientMock },
+        CredentialsService,
+      ],
+    }).compile();
+
+    service = module.get<CredentialsService>(CredentialsService);
+  });
+
+  describe('find', () => {
+    it('should call the natsClient send method with the correct arguments', (done) => {
+      const unsubscribe$ = new Subject<void>();
+      const tenantId = 'tenantId';
+      const expectedResult: EventAnonCredsCredentialsGetAll['data'] = [];
+
+      natsClientMock.send.mockReturnValueOnce(
+        of(new EventAnonCredsCredentialsGetAll(expectedResult, tenantId)),
+      );
+
+      service
+        .find(tenantId)
+        .pipe(takeUntil(unsubscribe$))
+        .subscribe((result) => {
+          expect(natsClientMock.send).toHaveBeenCalledWith(
+            EventAnonCredsCredentialsGetAll.token,
+            { tenantId },
+          );
+
+          expect(result).toStrictEqual(expectedResult);
+
+          unsubscribe$.next();
+          unsubscribe$.complete();
+
+          done();
+        });
+    });
+  });
+
+  describe('get', () => {
+    it('should call the natsClient send method with the correct arguments', (done) => {
+      const unsubscribe$ = new Subject<void>();
+      const tenantId = 'tenantId';
+      const credentialRecordId = 'credentialRecordId';
+      const expectedResult = {} as EventAnonCredsCredentialsGetById['data'];
+
+      natsClientMock.send.mockReturnValueOnce(
+        of(new EventAnonCredsCredentialsGetById(expectedResult, tenantId)),
+      );
+
+      service
+        .get(tenantId, credentialRecordId)
+        .pipe(takeUntil(unsubscribe$))
+        .subscribe((result) => {
+          expect(natsClientMock.send).toHaveBeenCalledWith(
+            EventAnonCredsCredentialsGetById.token,
+            { tenantId, credentialRecordId },
+          );
+
+          expect(result).toStrictEqual(expectedResult);
+
+          unsubscribe$.next();
+          unsubscribe$.complete();
+
+          done();
+        });
+    });
+  });
+
+  describe('delete', () => {
+    it('should call the natsClient send method with the correct arguments', (done) => {
+      const unsubscribe$ = new Subject<void>();
+      const tenantId = 'tenantId';
+      const credentialRecordId = 'credentialRecordId';
+      const expectedResult = {} as EventAnonCredsCredentialsDeleteById['data'];
+
+      natsClientMock.send.mockReturnValueOnce(
+        of(new EventAnonCredsCredentialsDeleteById(expectedResult, tenantId)),
+      );
+
+      service
+        .delete(tenantId, credentialRecordId)
+        .pipe(takeUntil(unsubscribe$))
+        .subscribe((result) => {
+          expect(natsClientMock.send).toHaveBeenCalledWith(
+            EventAnonCredsCredentialsDeleteById.token,
+            { tenantId, credentialRecordId },
+          );
+
+          expect(result).toStrictEqual(expectedResult);
+
+          unsubscribe$.next();
+          unsubscribe$.complete();
+
+          done();
+        });
+    });
+  });
+});

apps/credential-manager/src/credentials/credentials.controller.ts

+import {
+  Controller,
+  Delete,
+  Get,
+  HttpStatus,
+  Param,
+  Query,
+  UseInterceptors,
+  UsePipes,
+  ValidationPipe,
+} from '@nestjs/common';
+import { ApiOperation, ApiResponse, ApiTags } from '@nestjs/swagger';
+import { MultitenancyParams, ResponseFormatInterceptor } from '@ocm/shared';
+
+import { CredentialsService } from './credentials.service.js';
+import { DeleteParams } from './dto/delete.dto.js';
+import { GetParams } from './dto/get.dto.js';
+
+@Controller()
+@UsePipes(new ValidationPipe({ transform: true, whitelist: true }))
+@UseInterceptors(ResponseFormatInterceptor)
+@ApiTags('Credentials')
+export class CredentialsController {
+  public constructor(private readonly service: CredentialsService) {}
+
+  @Get()
+  @ApiOperation({
+    summary: 'Fetch a list of credentials',
+    description: 'This call provides a list of credentials for a given tenant',
+  })
+  @ApiResponse({
+    status: HttpStatus.OK,
+    description: 'Credentials fetched successfully',
+    content: {
+      'application/json': {
+        schema: {},
+        examples: {
+          'Credentials fetched successfully': {
+            value: {
+              statusCode: 200,
+              message: 'Credentials fetched successfully',
+              data: [
+                {
+                  id: '71b784a3',
+                },
+              ],
+            },
+          },
+        },
+      },
+    },
+  })
+  @ApiResponse({
+    status: HttpStatus.NOT_FOUND,
+    content: {
+      'application/json': {
+        schema: {},
+        examples: {
+          'Tenant not found': {
+            value: {
+              statusCode: 404,
+              message: 'Tenant not found',
+              data: null,
+            },
+          },
+        },
+      },
+    },
+  })
+  @ApiResponse({
+    status: HttpStatus.INTERNAL_SERVER_ERROR,
+    content: {
+      'application/json': {
+        schema: {},
+        examples: {
+          'Internal server error': {
+            value: {
+              statusCode: 500,
+              message: 'Internal server error',
+              data: null,
+            },
+          },
+        },
+      },
+    },
+  })
+  public find(@Query() { tenantId }: MultitenancyParams) {
+    return this.service.find(tenantId);
+  }
+
+  @Get(':credentialId')
+  @ApiOperation({
+    summary: 'Fetch a credential',
+    description: 'This call provides a credential for a given tenant',
+  })
+  @ApiResponse({
+    status: HttpStatus.OK,
+    description: 'Credential fetched successfully',
+    content: {
+      'application/json': {
+        schema: {},
+        examples: {
+          'Credential fetched successfully': {
+            value: {
+              statusCode: 200,
+              message: 'Credential fetched successfully',
+              data: {
+                id: '71b784a3',
+              },
+            },
+          },
+        },
+      },
+    },
+  })
+  @ApiResponse({
+    status: HttpStatus.NOT_FOUND,
+    content: {
+      'application/json': {
+        schema: {},
+        examples: {
+          'Credential not found': {
+            value: {
+              statusCode: 404,
+              message: 'Credential not found',
+              data: null,
+            },
+          },
+          'Tenant not found': {
+            value: {
+              statusCode: 404,
+              message: 'Tenant not found',
+              data: null,
+            },
+          },
+        },
+      },
+    },
+  })
+  @ApiResponse({
+    status: HttpStatus.INTERNAL_SERVER_ERROR,
+    content: {
+      'application/json': {
+        schema: {},
+        examples: {
+          'Internal server error': {
+            value: {
+              statusCode: 500,
+              message: 'Internal server error',
+              data: null,
+            },
+          },
+        },
+      },
+    },
+  })
+  public get(
+    @Param() { credentialRecordId }: GetParams,
+    @Query() { tenantId }: MultitenancyParams,
+  ) {
+    return this.service.get(tenantId, credentialRecordId);
+  }
+
+  @Delete(':credentialId')
+  @ApiOperation({
+    summary: 'Delete a credential',
+    description: 'This call deletes a credential for a given tenant',
+  })
+  @ApiResponse({
+    status: HttpStatus.OK,
+    description: 'Credential deleted successfully',
+    content: {
+      'application/json': {
+        schema: {},
+        examples: {
+          'Credential deleted successfully': {
+            value: {
+              statusCode: 200,
+              message: 'Credential deleted successfully',
+              data: null,
+            },
+          },
+        },
+      },
+    },
+  })
+  @ApiResponse({
+    status: HttpStatus.NOT_FOUND,
+    content: {
+      'application/json': {
+        schema: {},
+        examples: {
+          'Credential not found': {
+            value: {
+              statusCode: 404,
+              message: 'Credential not found',
+              data: null,
+            },
+          },
+          'Tenant not found': {
+            value: {
+              statusCode: 404,
+              message: 'Tenant not found',
+              data: null,
+            },
+          },
+        },
+      },
+    },
+  })
+  @ApiResponse({
+    status: HttpStatus.INTERNAL_SERVER_ERROR,
+    content: {
+      'application/json': {
+        schema: {},
+        examples: {
+          'Internal server error': {
+            value: {
+              statusCode: 500,
+              message: 'Internal server error',
+              data: null,
+            },
+          },
+        },
+      },
+    },
+  })
+  public delete(
+    @Param() { credentialRecordId }: DeleteParams,
+    @Query() { tenantId }: MultitenancyParams,
+  ) {
+    return this.service.delete(tenantId, credentialRecordId);
+  }
+}

apps/credential-manager/src/credentials/credentials.module.ts

+import { Module } from '@nestjs/common';
+
+import { CredentialsController } from './credentials.controller.js';
+import { CredentialsService } from './credentials.service.js';
+
+@Module({
+  providers: [CredentialsService],
+  controllers: [CredentialsController],
+})
+export class CredentialsModule {}

apps/credential-manager/src/credentials/credentials.service.ts

+import type {
+  EventAnonCredsCredentialsDeleteByIdInput,
+  EventAnonCredsCredentialsGetAllInput,
+  EventAnonCredsCredentialsGetByIdInput,
+} from '@ocm/shared';
+import type { Observable } from 'rxjs';
+
+import { Inject, Injectable } from '@nestjs/common';
+import { ClientProxy } from '@nestjs/microservices';
+import {
+  EventAnonCredsCredentialsDeleteById,
+  EventAnonCredsCredentialsGetAll,
+  EventAnonCredsCredentialsGetById,
+} from '@ocm/shared';
+import { map } from 'rxjs';
+
+import { NATS_CLIENT } from '../common/constants.js';
+
+@Injectable()
+export class CredentialsService {
+  public constructor(
+    @Inject(NATS_CLIENT) private readonly natsClient: ClientProxy,
+  ) {}
+
+  public find(
+    tenantId: string,
+  ): Observable<EventAnonCredsCredentialsGetAll['data']> {
+    return this.natsClient
+      .send<
+        EventAnonCredsCredentialsGetAll,
+        EventAnonCredsCredentialsGetAllInput
+      >(EventAnonCredsCredentialsGetAll.token, {
+        tenantId,
+      })
+      .pipe(map(({ data }) => data));
+  }
+
+  public get(
+    tenantId: string,
+    credentialRecordId: string,
+  ): Observable<EventAnonCredsCredentialsGetById['data']> {
+    return this.natsClient
+      .send<
+        EventAnonCredsCredentialsGetById,
+        EventAnonCredsCredentialsGetByIdInput
+      >(EventAnonCredsCredentialsGetById.token, {
+        tenantId,
+        credentialRecordId,
+      })
+      .pipe(map(({ data }) => data));
+  }
+
+  public delete(
+    tenantId: string,
+    credentialRecordId: string,
+  ): Observable<EventAnonCredsCredentialsDeleteById['data']> {
+    return this.natsClient
+      .send<
+        EventAnonCredsCredentialsDeleteById,
+        EventAnonCredsCredentialsDeleteByIdInput
+      >(EventAnonCredsCredentialsDeleteById.token, {
+        tenantId,
+        credentialRecordId,
+      })
+      .pipe(map(({ data }) => data));
+  }
+}

apps/credential-manager/src/credentials/dto/delete.dto.ts

+import { ApiProperty } from '@nestjs/swagger';
+import { IsNotEmpty, IsString } from 'class-validator';
+
+export class DeleteParams {
+  @IsString()
+  @IsNotEmpty()
+  @ApiProperty({
+    description: 'The credential record ID to delete',
+    format: 'string',
+  })
+  public credentialRecordId: string;
+}

apps/credential-manager/src/credentials/dto/get.dto.ts

+import { ApiProperty } from '@nestjs/swagger';
+import { IsNotEmpty, IsString } from 'class-validator';
+
+export class GetParams {
+  @IsString()
+  @IsNotEmpty()
+  @ApiProperty({
+    description: 'The credential record ID to retrieve',
+    format: 'string',
+  })
+  public credentialRecordId: string;
+}