refactor: api key repository (#15491)

server/src/services/api-key.service.spec.ts

@@ -1,8 +1,8 @@
 import { BadRequestException } from '@nestjs/common';
 import { Permission } from 'src/enum';
-import { IKeyRepository } from 'src/interfaces/api-key.interface';
 import { ICryptoRepository } from 'src/interfaces/crypto.interface';
 import { APIKeyService } from 'src/services/api-key.service';
+import { IApiKeyRepository } from 'src/types';
 import { keyStub } from 'test/fixtures/api-key.stub';
 import { authStub } from 'test/fixtures/auth.stub';
 import { newTestService } from 'test/utils';
@@ -12,7 +12,7 @@ describe(APIKeyService.name, () => {
   let sut: APIKeyService;
 
   let cryptoMock: Mocked<ICryptoRepository>;
-  let keyMock: Mocked<IKeyRepository>;
+  let keyMock: Mocked<IApiKeyRepository>;
 
   beforeEach(() => {
     ({ sut, cryptoMock, keyMock } = newTestService(APIKeyService));
@@ -56,8 +56,6 @@ describe(APIKeyService.name, () => {
 
   describe('update', () => {
     it('should throw an error if the key is not found', async () => {
-      keyMock.getById.mockResolvedValue(null);
-
       await expect(sut.update(authStub.admin, 'random-guid', { name: 'New Name' })).rejects.toBeInstanceOf(
         BadRequestException,
       );
@@ -77,8 +75,6 @@ describe(APIKeyService.name, () => {
 
   describe('delete', () => {
     it('should throw an error if the key is not found', async () => {
-      keyMock.getById.mockResolvedValue(null);
-
       await expect(sut.delete(authStub.admin, 'random-guid')).rejects.toBeInstanceOf(BadRequestException);
 
       expect(keyMock.delete).not.toHaveBeenCalledWith('random-guid');
@@ -95,8 +91,6 @@ describe(APIKeyService.name, () => {
 
   describe('getById', () => {
     it('should throw an error if the key is not found', async () => {
-      keyMock.getById.mockResolvedValue(null);
-
       await expect(sut.getById(authStub.admin, 'random-guid')).rejects.toBeInstanceOf(BadRequestException);
 
       expect(keyMock.getById).toHaveBeenCalledWith(authStub.admin.user.id, 'random-guid');

server/src/services/api-key.service.ts

@@ -1,8 +1,9 @@
 import { BadRequestException, Injectable } from '@nestjs/common';
 import { APIKeyCreateDto, APIKeyCreateResponseDto, APIKeyResponseDto, APIKeyUpdateDto } from 'src/dtos/api-key.dto';
 import { AuthDto } from 'src/dtos/auth.dto';
-import { APIKeyEntity } from 'src/entities/api-key.entity';
+import { Permission } from 'src/enum';
 import { BaseService } from 'src/services/base.service';
+import { ApiKeyItem } from 'src/types';
 import { isGranted } from 'src/utils/access';
 
 @Injectable()
@@ -57,13 +58,13 @@ export class APIKeyService extends BaseService {
     return keys.map((key) => this.map(key));
   }
 
-  private map(entity: APIKeyEntity): APIKeyResponseDto {
+  private map(entity: ApiKeyItem): APIKeyResponseDto {
     return {
       id: entity.id,
       name: entity.name,
       createdAt: entity.createdAt,
       updatedAt: entity.updatedAt,
-      permissions: entity.permissions,
+      permissions: entity.permissions as Permission[],
     };
   }
 }

server/src/services/auth.service.spec.ts

@@ -3,7 +3,6 @@ import { AuthDto, SignUpDto } from 'src/dtos/auth.dto';
 import { UserMetadataEntity } from 'src/entities/user-metadata.entity';
 import { UserEntity } from 'src/entities/user.entity';
 import { AuthType, Permission } from 'src/enum';
-import { IKeyRepository } from 'src/interfaces/api-key.interface';
 import { ICryptoRepository } from 'src/interfaces/crypto.interface';
 import { IEventRepository } from 'src/interfaces/event.interface';
 import { IOAuthRepository } from 'src/interfaces/oauth.interface';
@@ -12,6 +11,7 @@ import { ISharedLinkRepository } from 'src/interfaces/shared-link.interface';
 import { ISystemMetadataRepository } from 'src/interfaces/system-metadata.interface';
 import { IUserRepository } from 'src/interfaces/user.interface';
 import { AuthService } from 'src/services/auth.service';
+import { IApiKeyRepository } from 'src/types';
 import { keyStub } from 'test/fixtures/api-key.stub';
 import { authStub } from 'test/fixtures/auth.stub';
 import { sessionStub } from 'test/fixtures/session.stub';
@@ -62,7 +62,7 @@ describe('AuthService', () => {
 
   let cryptoMock: Mocked<ICryptoRepository>;
   let eventMock: Mocked<IEventRepository>;
-  let keyMock: Mocked<IKeyRepository>;
+  let keyMock: Mocked<IApiKeyRepository>;
   let oauthMock: Mocked<IOAuthRepository>;
   let sessionMock: Mocked<ISessionRepository>;
   let sharedLinkMock: Mocked<ISharedLinkRepository>;

server/src/services/auth.service.ts

@@ -21,6 +21,7 @@ import { UserEntity } from 'src/entities/user.entity';
 import { AuthType, ImmichCookie, ImmichHeader, ImmichQuery, Permission } from 'src/enum';
 import { OAuthProfile } from 'src/interfaces/oauth.interface';
 import { BaseService } from 'src/services/base.service';
+import { AuthApiKey } from 'src/types';
 import { isGranted } from 'src/utils/access';
 import { HumanReadableSize } from 'src/utils/bytes';
 
@@ -309,7 +310,10 @@ export class AuthService extends BaseService {
     const hashedKey = this.cryptoRepository.hashSha256(key);
     const apiKey = await this.keyRepository.getKey(hashedKey);
     if (apiKey) {
-      return { user: apiKey.user, apiKey };
+      return {
+        user: apiKey.user as unknown as UserEntity,
+        apiKey: apiKey as unknown as AuthApiKey,
+      };
     }
 
     throw new UnauthorizedException('Invalid API key');

server/src/services/base.service.ts

@@ -8,7 +8,6 @@ import { Users } from 'src/db';
 import { UserEntity } from 'src/entities/user.entity';
 import { IAlbumUserRepository } from 'src/interfaces/album-user.interface';
 import { IAlbumRepository } from 'src/interfaces/album.interface';
-import { IKeyRepository } from 'src/interfaces/api-key.interface';
 import { IAssetRepository } from 'src/interfaces/asset.interface';
 import { IAuditRepository } from 'src/interfaces/audit.interface';
 import { IConfigRepository } from 'src/interfaces/config.interface';
@@ -45,6 +44,7 @@ import { IVersionHistoryRepository } from 'src/interfaces/version-history.interf
 import { IViewRepository } from 'src/interfaces/view.interface';
 import { AccessRepository } from 'src/repositories/access.repository';
 import { ActivityRepository } from 'src/repositories/activity.repository';
+import { ApiKeyRepository } from 'src/repositories/api-key.repository';
 import { AccessRequest, checkAccess, requireAccess } from 'src/utils/access';
 import { getConfig, updateConfig } from 'src/utils/config';
 
@@ -65,7 +65,7 @@ export class BaseService {
     @Inject(IDatabaseRepository) protected databaseRepository: IDatabaseRepository,
     @Inject(IEventRepository) protected eventRepository: IEventRepository,
     @Inject(IJobRepository) protected jobRepository: IJobRepository,
-    @Inject(IKeyRepository) protected keyRepository: IKeyRepository,
+    protected keyRepository: ApiKeyRepository,
     @Inject(ILibraryRepository) protected libraryRepository: ILibraryRepository,
     @Inject(IMachineLearningRepository) protected machineLearningRepository: IMachineLearningRepository,
     @Inject(IMapRepository) protected mapRepository: IMapRepository,