chore: tree shake unused API methods from CLI (#6973)

cli/src/services/api.service.ts

@@ -1,56 +1,106 @@
 import {
-  AlbumApi,
-  APIKeyApi,
-  AssetApi,
-  AuthenticationApi,
-  Configuration,
-  JobApi,
-  OAuthApi,
-  ServerInfoApi,
-  SystemConfigApi,
-  UserApi,
+  addAssetsToAlbum,
+  checkBulkUpload,
+  createAlbum,
+  createApiKey,
+  getAllAlbums,
+  getAllAssets,
+  getAssetStatistics,
+  getMyUserInfo,
+  getServerVersion,
+  getSupportedMediaTypes,
+  login,
+  pingServer,
+  signUpAdmin,
+  uploadFile,
+  ApiKeyCreateDto,
+  AssetBulkUploadCheckDto,
+  BulkIdsDto,
+  CreateAlbumDto,
+  CreateAssetDto,
+  LoginCredentialDto,
+  SignUpDto,
 } from '@immich/sdk';
 
+/**
+ * Wraps the underlying API to abstract away the options and make API calls mockable for testing.
+ */
 export class ImmichApi {
-  public userApi: UserApi;
-  public albumApi: AlbumApi;
-  public assetApi: AssetApi;
-  public authenticationApi: AuthenticationApi;
-  public oauthApi: OAuthApi;
-  public serverInfoApi: ServerInfoApi;
-  public jobApi: JobApi;
-  public keyApi: APIKeyApi;
-  public systemConfigApi: SystemConfigApi;
-
-  private readonly config;
+  private readonly options;
 
   constructor(
     public instanceUrl: string,
     public apiKey: string,
   ) {
-    this.config = new Configuration({
-      basePath: instanceUrl,
+    this.options = {
+      baseUrl: instanceUrl,
       headers: {
         'x-api-key': apiKey,
       },
-    });
-
-    this.userApi = new UserApi(this.config);
-    this.albumApi = new AlbumApi(this.config);
-    this.assetApi = new AssetApi(this.config);
-    this.authenticationApi = new AuthenticationApi(this.config);
-    this.oauthApi = new OAuthApi(this.config);
-    this.serverInfoApi = new ServerInfoApi(this.config);
-    this.jobApi = new JobApi(this.config);
-    this.keyApi = new APIKeyApi(this.config);
-    this.systemConfigApi = new SystemConfigApi(this.config);
+    };
   }
 
   setApiKey(apiKey: string) {
     this.apiKey = apiKey;
-    if (!this.config.headers) {
+    if (!this.options.headers) {
       throw new Error('missing headers');
     }
-    this.config.headers['x-api-key'] = apiKey;
+    this.options.headers['x-api-key'] = apiKey;
+  }
+
+  async addAssetsToAlbum(id: string, bulkIdsDto: BulkIdsDto) {
+    return await addAssetsToAlbum({ id, bulkIdsDto }, this.options);
+  }
+
+  async checkBulkUpload(assetBulkUploadCheckDto: AssetBulkUploadCheckDto) {
+    return await checkBulkUpload({ assetBulkUploadCheckDto }, this.options);
+  }
+
+  async createAlbum(createAlbumDto: CreateAlbumDto) {
+    return await createAlbum({ createAlbumDto }, this.options);
+  }
+
+  async createApiKey(apiKeyCreateDto: ApiKeyCreateDto, options: { headers: { Authorization: string } }) {
+    return await createApiKey({ apiKeyCreateDto }, { ...this.options, ...options });
+  }
+
+  async getAllAlbums() {
+    return await getAllAlbums({}, this.options);
+  }
+
+  async getAllAssets() {
+    return await getAllAssets({}, this.options);
+  }
+
+  async getAssetStatistics() {
+    return await getAssetStatistics({}, this.options);
+  }
+
+  async getMyUserInfo() {
+    return await getMyUserInfo(this.options);
+  }
+
+  async getServerVersion() {
+    return await getServerVersion(this.options);
+  }
+
+  async getSupportedMediaTypes() {
+    return await getSupportedMediaTypes(this.options);
+  }
+
+  async login(loginCredentialDto: LoginCredentialDto) {
+    return await login({ loginCredentialDto }, this.options);
+  }
+
+  async pingServer() {
+    return await pingServer(this.options);
+  }
+
+  async signUpAdmin(signUpDto: SignUpDto) {
+    return await signUpAdmin({ signUpDto }, this.options);
+  }
+
+  async uploadFile(createAssetDto: CreateAssetDto) {
+    return await uploadFile({ createAssetDto }, this.options);
   }
 }

cli/src/services/session.service.spec.ts

@@ -12,18 +12,20 @@ import {
   spyOnConsole,
 } from '../../test/cli-test-utils';
 
-const mockPingServer = vi.fn(() => Promise.resolve({ res: 'pong' }));
-const mockUserInfo = vi.fn(() => Promise.resolve({ email: 'admin@example.com' }));
+const mocks = vi.hoisted(() => {
+  return {
+    getMyUserInfo: vi.fn(() => Promise.resolve({ email: 'admin@example.com' })),
+    pingServer: vi.fn(() => Promise.resolve({ res: 'pong' })),
+  };
+});
 
-vi.mock('@immich/sdk', async () => ({
-  ...(await vi.importActual('@immich/sdk')),
-  UserApi: vi.fn().mockImplementation(() => {
-    return { getMyUserInfo: mockUserInfo };
-  }),
-  ServerInfoApi: vi.fn().mockImplementation(() => {
-    return { pingServer: mockPingServer };
-  }),
-}));
+vi.mock('./api.service', async (importOriginal) => {
+  const module = await importOriginal<typeof import('./api.service')>();
+  // @ts-expect-error this is only a partial implementation of the return value
+  module.ImmichApi.prototype.getMyUserInfo = mocks.getMyUserInfo;
+  module.ImmichApi.prototype.pingServer = mocks.pingServer;
+  return module;
+});
 
 describe('SessionService', () => {
   let sessionService: SessionService;
@@ -46,7 +48,7 @@ describe('SessionService', () => {
     );
 
     await sessionService.connect();
-    expect(mockPingServer).toHaveBeenCalledTimes(1);
+    expect(mocks.pingServer).toHaveBeenCalledTimes(1);
   });
 
   it('should error if no auth file exists', async () => {

cli/src/services/session.service.ts

@@ -3,7 +3,6 @@ import { access, constants, mkdir, readFile, unlink, writeFile } from 'node:fs/p
 import path from 'node:path';
 import yaml from 'yaml';
 import { ImmichApi } from './api.service';
-
 class LoginError extends Error {
   constructor(message: string) {
     super(message);
@@ -51,12 +50,12 @@ export class SessionService {
 
     const api = new ImmichApi(instanceUrl, apiKey);
 
-    const pingResponse = await api.serverInfoApi.pingServer().catch((error) => {
-      throw new Error(`Failed to connect to server ${api.instanceUrl}: ${error.message}`);
+    const pingResponse = await api.pingServer().catch((error) => {
+      throw new Error(`Failed to connect to server ${instanceUrl}: ${error.message}`, error);
     });
 
     if (pingResponse.res !== 'pong') {
-      throw new Error(`Could not parse response. Is Immich listening on ${api.instanceUrl}?`);
+      throw new Error(`Could not parse response. Is Immich listening on ${instanceUrl}?`);
     }
 
     return api;
@@ -68,7 +67,7 @@ export class SessionService {
     const api = new ImmichApi(instanceUrl, apiKey);
 
     // Check if server and api key are valid
-    const userInfo = await api.userApi.getMyUserInfo().catch((error) => {
+    const userInfo = await api.getMyUserInfo().catch((error) => {
       throw new LoginError(`Failed to connect to server ${instanceUrl}: ${error.message}`);
     });