refactor: rename services to apiClients when needed

JulienMessageIppon · JulienMessageIppon · commit 5654dbdeff22 · 2026-02-02T09:33:11.000+01:00
diff --git a/components/alert/AlertAddAnalysis.vue b/components/alert/AlertAddAnalysis.vue
@@ -85,7 +85,7 @@ const addFile = (event: Event) => {
 const uploadFile = async () => {
   if (!file.value) return;
   loading.value = true;
-  await $api.curService.uploadFile(file.value);
+  await $api.curApiClient.uploadFile(file.value);
   loading.value = false;
   emit("update:analyses");
   closeModal();
diff --git a/components/comparative/ComparativeByRegion.vue b/components/comparative/ComparativeByRegion.vue
@@ -63,7 +63,7 @@ interface Props {
 const props = defineProps<Props>();
 
 const resultsByRegion: Ref<RegionCarbonFootprint[]> = ref(
-  await $api.carbon.compareCarbonFootPrintbByRegion(
+  await $api.carbonService.compareCarbonFootPrintbByRegion(
     props.infrastructureId,
     props.totalCO2Gr,
   ),
diff --git a/components/configurationSettings/ConfigurationSettingsInstanceType.vue b/components/configurationSettings/ConfigurationSettingsInstanceType.vue
@@ -26,7 +26,7 @@ const { $api } = useNuxtApp();
 const instanceTypes: Ref<string[]> = ref([]);
 const isInstanceEmpty = ref(false);
 
-$api.instanceType.getAllInstanceByType("EC2").then((responses) => {
+$api.awsInstanceApiClient.getAllInstanceByType("EC2").then((responses) => {
   instanceTypes.value = responses.map((response) => response.name);
 });
 
diff --git a/components/infrastructure/InfrastructureCreate.vue b/components/infrastructure/InfrastructureCreate.vue
@@ -120,7 +120,7 @@ const handleSubmit = form.handleSubmit(async (values) => {
     defaultRegion: values.region.id,
     name: values.infraName,
   };
-  await $api.infrastructureService.createNewInfra(infra);
+  await $api.infrastructureApiClient.createNewInfra(infra);
   await infrastructuresStore.fetchInfrastructures();
   isDialogOpen.value = false;
   emit("infraCreated");
diff --git a/components/infrastructure/InfrastructureDataTable.vue b/components/infrastructure/InfrastructureDataTable.vue
@@ -97,7 +97,7 @@ function deleteInfrastructure(infrastructure: Infrastructure) {
 }
 
 async function confirmInfrastructureDeletion(infrastructure: Infrastructure) {
-  await $api.infrastructureService.deleteInfra(infrastructure.id!);
+  await $api.infrastructureApiClient.deleteInfra(infrastructure.id!);
   await infrastructuresStore.fetchInfrastructures();
 }
 
diff --git a/pages/admin/dashboard.vue b/pages/admin/dashboard.vue
@@ -28,7 +28,7 @@ const notificationHandler = useToast();
 const { $api } = useNuxtApp();
 
 const clearCache = async () => {
-  await $api.adminService.evictRegionCache().then(() =>
+  await $api.adminApiClient.evictRegionCache().then(() =>
     notificationHandler.add({
       title: $t("admin.regionCache.notifyCleared"),
       color: NuxtColors.success,
diff --git a/pages/calculatrice/estimation/[infrastructureID]/index.vue b/pages/calculatrice/estimation/[infrastructureID]/index.vue
@@ -52,9 +52,9 @@ const infrastructureId: string = Array.isArray(route.params.infrastructureID)
   : route.params.infrastructureID;
 
 const results = ref(
-  await $api.carbon.estimateCarbonFootPrint(infrastructureId),
+  await $api.carbonService.estimateCarbonFootPrint(infrastructureId),
 );
 
 infrastructure.value =
-  await $api.infrastructureService.getInfrastructure(infrastructureId);
+  await $api.infrastructureApiClient.getInfrastructure(infrastructureId);
 </script>
diff --git a/pages/calculatrice/infrastructure/[infrastructureID]/available-services.vue b/pages/calculatrice/infrastructure/[infrastructureID]/available-services.vue
@@ -64,7 +64,7 @@ const route = useRoute();
 
 const services = ref<CloudServiceProviderService[]>([]);
 services.value =
-  await $api.cloudServiceProviderService.getCloudServiceProviderServices();
+  await $api.cloudServiceProviderApiClient.getCloudServiceProviderServices();
 
 const goToComponentConfiguration = (
   cloudServiceProviderService: CloudServiceProviderService,
diff --git a/pages/calculatrice/infrastructure/[infrastructureID]/create-component.vue b/pages/calculatrice/infrastructure/[infrastructureID]/create-component.vue
@@ -113,7 +113,9 @@ const { cloudServiceProviderServiceID, componentId, serviceName } =
   route.query as QueryParams;
 
 const components = ref(
-  await $api.componentService.getComponentsByInfrastructureId(infrastructureId),
+  await $api.componentApiClient.getComponentsByInfrastructureId(
+    infrastructureId,
+  ),
 );
 
 const originalComponent = components.value.find(
@@ -133,7 +135,7 @@ const isOtherRegion = ref(
 );
 
 const serviceConfigurationSettings = ref<ServiceConfigurationSetting[]>(
-  await $api.serviceConfigurationSettingSvc.findAllConfigurationSettingsByServiceId(
+  await $api.serviceConfigurationSettingApiClient.findAllConfigurationSettingsByServiceId(
     originalComponent
       ? originalComponent.serviceID
       : cloudServiceProviderServiceID,
@@ -171,12 +173,12 @@ const handleSubmit = async () => {
     serviceID: cloudServiceProviderServiceID,
   };
   if (originalComponent) {
-    await $api.componentService.updateComponent({
+    await $api.componentApiClient.updateComponent({
       ...component,
       id: originalComponent.id,
     });
   } else {
-    await $api.componentService.saveComponent(component);
+    await $api.componentApiClient.saveComponent(component);
   }
   await navigateTo(`/calculatrice/infrastructure/${infrastructureId}`);
 };
diff --git a/pages/calculatrice/infrastructure/[infrastructureID]/index.vue b/pages/calculatrice/infrastructure/[infrastructureID]/index.vue
@@ -116,7 +116,9 @@ const infrastructureId: string = Array.isArray(route.params.infrastructureID)
 
 const { $api } = useNuxtApp();
 const components = ref(
-  await $api.componentService.getComponentsByInfrastructureId(infrastructureId),
+  await $api.componentApiClient.getComponentsByInfrastructureId(
+    infrastructureId,
+  ),
 );
 
 const componentToDelete = ref<string>("");
@@ -134,18 +136,18 @@ const addComponent = () => {
 };
 
 async function deleteComponent() {
-  await useNuxtApp().$api.componentService.deleteComponent(
+  await useNuxtApp().$api.componentApiClient.deleteComponent(
     componentToDelete.value,
   );
   components.value =
-    await $api.componentService.getComponentsByInfrastructureId(
+    await $api.componentApiClient.getComponentsByInfrastructureId(
       infrastructureId,
     );
 }
 const navigateToEdit = async (component: Component) => {
   const { id: componentId, serviceID } = component;
   const serviceName =
-    (await $api.catalogService.getById(serviceID)).shortname ?? "";
+    (await $api.catalogApiClient.getById(serviceID)).shortname ?? "";
   navigateTo({
     path: `/calculatrice/infrastructure/${infrastructureId}/create-component`,
     query: {
diff --git a/pages/catalog/[serviceId]/index.vue b/pages/catalog/[serviceId]/index.vue
@@ -39,7 +39,7 @@ const {
 const id: string = Array.isArray(serviceId) ? serviceId[0] : serviceId;
 
 const service: Ref<ServiceDescription> = ref(
-  await $api.catalogService.getById(id),
+  await $api.catalogApiClient.getById(id),
 );
 </script>
 
diff --git a/pages/catalog/index.vue b/pages/catalog/index.vue
@@ -25,11 +25,9 @@ definePageMeta({
   layout: "public",
 });
 
-// const services: Ref<ServiceCatalog[]> = ref([]);
-
 const { $api, $router } = useNuxtApp();
 
-const services = ref(await $api.catalogService.getAllServices());
+const services = ref(await $api.catalogApiClient.getAllServices());
 
 const toDescription = (id: string) => {
   $router.push(`catalog/${id}`);
diff --git a/plugins/02-irocalcApi.ts b/plugins/02-irocalcApi.ts
@@ -39,16 +39,16 @@ import ScanApiClient from "~/service/api/scanApiClient";
 /** ApiInstance interface provides us with good typing */
 interface IApiInstance {
   awsDataCenter: AWSDataCenterService;
-  carbon: CarbonService;
-  catalogService: CatalogApiClient;
-  instanceType: AWSInstanceApiClient;
-  adminService: AdminApiClient;
-  infrastructureService: InfrastructureApiClient;
-  componentService: ComponentApiClient;
-  cloudServiceProviderService: CloudServiceProviderApiClient;
-  serviceConfigurationSettingSvc: ServiceConfigurationSettingApiClient;
+  carbonService: CarbonService;
+  catalogApiClient: CatalogApiClient;
+  awsInstanceApiClient: AWSInstanceApiClient;
+  adminApiClient: AdminApiClient;
+  infrastructureApiClient: InfrastructureApiClient;
+  componentApiClient: ComponentApiClient;
+  cloudServiceProviderApiClient: CloudServiceProviderApiClient;
+  serviceConfigurationSettingApiClient: ServiceConfigurationSettingApiClient;
   analysisService: AnalysisService;
-  curService: CurApiClient;
+  curApiClient: CurApiClient;
   tokenService: TokenService;
   scanService: ScanService;
 }
@@ -103,24 +103,23 @@ export default defineNuxtPlugin({
 
     /** an object containing all repositories we need to expose */
     const modules: IApiInstance = {
-      carbon: new CarbonService(new IrocalcCarbonApiClient(apiFetcher)),
+      carbonService: new CarbonService(new IrocalcCarbonApiClient(apiFetcher)),
       awsDataCenter: new AWSDataCenterService(
         infrastructureApiClient,
         new AWSDataCenterApiClient(apiFetcher),
       ),
-      catalogService: new CatalogApiClient(apiFetcher),
-      instanceType: new AWSInstanceApiClient(apiFetcher),
-      adminService: new AdminApiClient(apiFetcher),
-      infrastructureService: infrastructureApiClient,
-      componentService: new ComponentApiClient(apiFetcher),
-      cloudServiceProviderService: new CloudServiceProviderApiClient(
-        apiFetcher,
-      ),
-      serviceConfigurationSettingSvc: new ServiceConfigurationSettingApiClient(
+      catalogApiClient: new CatalogApiClient(apiFetcher),
+      awsInstanceApiClient: new AWSInstanceApiClient(apiFetcher),
+      adminApiClient: new AdminApiClient(apiFetcher),
+      infrastructureApiClient: infrastructureApiClient,
+      componentApiClient: new ComponentApiClient(apiFetcher),
+      cloudServiceProviderApiClient: new CloudServiceProviderApiClient(
         apiFetcher,
       ),
+      serviceConfigurationSettingApiClient:
+        new ServiceConfigurationSettingApiClient(apiFetcher),
       analysisService: new AnalysisService(new AnalysisApiClient(apiFetcher)),
-      curService: new CurApiClient(apiFetcher),
+      curApiClient: new CurApiClient(apiFetcher),
       tokenService: new TokenService(apiFetcher),
       scanService: new ScanService(new ScanApiClient(apiFetcher)),
     };
diff --git a/stores/cloud-service-provider.store.ts b/stores/cloud-service-provider.store.ts
@@ -25,7 +25,7 @@ export const useCloudServiceProviderStore = defineStore(
     const fetchCloudServiceProviders = async () => {
       if (cloudServiceProviders.value.length === 0)
         cloudServiceProviders.value =
-          await useNuxtApp().$api.cloudServiceProviderService.getCloudServiceProviders();
+          await useNuxtApp().$api.cloudServiceProviderApiClient.getCloudServiceProviders();
     };
 
     const getRegionBy = async (param: string, paramType: "id" | "name") => {
diff --git a/stores/infrastructures.store.ts b/stores/infrastructures.store.ts
@@ -22,7 +22,7 @@ export const useInfrastructuresStore = defineStore("infrastructures", () => {
 
   const fetchInfrastructures = async () => {
     infrastructures.value =
-      await useNuxtApp().$api.infrastructureService.getInfrastructures();
+      await useNuxtApp().$api.infrastructureApiClient.getInfrastructures();
   };
 
   return {
diff --git a/test/components/AddAnalysisAlert.spec.ts b/test/components/AddAnalysisAlert.spec.ts
@@ -30,7 +30,7 @@ const { mockUploadFile } = vi.hoisted(() => ({
 mockNuxtImport("useNuxtApp", () => {
   return () => ({
     $api: {
-      curService: {
+      curApiClient: {
         uploadFile: mockUploadFile,
       },
     },
@@ -42,7 +42,7 @@ describe("AddAnalysisAlert component", () => {
     mockNuxtImport("useNuxtApp", () => {
       return () => ({
         $api: {
-          curService: {
+          curApiClient: {
             uploadFile: mockUploadFile,
           },
         },
diff --git a/test/components/ConfigurationSettingsConfigurationSetting.spec.ts b/test/components/ConfigurationSettingsConfigurationSetting.spec.ts
@@ -91,7 +91,7 @@ describe("ConfigurationSettingsConfigurationSetting component", () => {
     mockNuxtImport("useNuxtApp", () => {
       return () => ({
         $api: {
-          instanceType: {
+          awsInstanceApiClient: {
             getAllInstanceByType: mockGetAllInstanceByType,
           },
         },
diff --git a/test/pages/catalog.test.ts b/test/pages/catalog.test.ts
@@ -15,7 +15,7 @@
  *
  * SPDX-License-Identifier: Apache-2.0
  */
-import { describe, it, expect, vi, beforeEach, afterEach } from "vitest";
+import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
 import type { VueWrapper } from "@vue/test-utils";
 import { mount } from "@vue/test-utils";
 import Catalog from "~/pages/catalog/index.vue";
@@ -33,7 +33,7 @@ describe("Catalog page", async () => {
     mockNuxtImport("useNuxtApp", () => {
       return () => ({
         $api: {
-          catalogService: {
+          catalogApiClient: {
             getAllServices:
               mockGetAllService.mockResolvedValue(catalogResponse),
           },
diff --git a/test/services/catalogService.spec.ts b/test/services/catalogService.spec.ts
@@ -23,12 +23,12 @@ import { Availability } from "~/type/Availability";
 import type { ServiceDescription } from "~/type/ServiceDescription";
 
 describe("CatalogService", () => {
-  let catalogService: CatalogApiClient;
+  let catalogApiClient: CatalogApiClient;
   let mockFetch: Mock;
 
   beforeEach(() => {
     mockFetch = vi.fn();
-    catalogService = new CatalogApiClient(mockFetch as unknown as $Fetch);
+    catalogApiClient = new CatalogApiClient(mockFetch as unknown as $Fetch);
   });
 
   afterEach(() => {
@@ -74,7 +74,7 @@ describe("CatalogService", () => {
     ];
 
     // Act
-    const services = await catalogService.getAllServices();
+    const services = await catalogApiClient.getAllServices();
 
     // Assert
     expect(services).toEqual(expectedSortedCatalog);
@@ -119,7 +119,7 @@ describe("CatalogService", () => {
     mockFetch.mockResolvedValue(serviceDescription);
 
     // Act
-    const description = await catalogService.getById(serviceId);
+    const description = await catalogApiClient.getById(serviceId);
 
     // Assert
     expect(description).toEqual(serviceDescription);
diff --git a/test/services/curService.spec.ts b/test/services/curService.spec.ts
@@ -30,15 +30,15 @@ const MOCK_SERVER_RESPONSE = {
 };
 
 describe("CurService", () => {
-  let curService: CurApiClient;
+  let curApiClient: CurApiClient;
   let mockFetch: Mock;
   let mockGlobalFetch: Mock;
 
   beforeEach(() => {
     mockFetch = vi.fn();
     mockGlobalFetch = vi.fn();
     global.fetch = mockGlobalFetch;
-    curService = new CurApiClient(mockFetch as unknown as $Fetch);
+    curApiClient = new CurApiClient(mockFetch as unknown as $Fetch);
   });
 
   afterEach(() => {
@@ -53,7 +53,7 @@ describe("CurService", () => {
       mockGlobalFetch.mockResolvedValue({ ok: true });
 
       // when
-      await curService.uploadFile(file);
+      await curApiClient.uploadFile(file);
 
       // then
       expect(mockFetch).toHaveBeenCalledWith(
@@ -77,7 +77,7 @@ describe("CurService", () => {
       mockGlobalFetch.mockResolvedValue({ ok: true });
 
       // when
-      await curService.uploadFile(file);
+      await curApiClient.uploadFile(file);
 
       // then
       expect(mockFetch).toHaveBeenCalledWith(
@@ -101,7 +101,7 @@ describe("CurService", () => {
       mockGlobalFetch.mockResolvedValue({ ok: true });
 
       // when
-      await curService.uploadFile(file);
+      await curApiClient.uploadFile(file);
 
       // then
       expect(mockFetch).toHaveBeenCalledWith(
@@ -119,7 +119,7 @@ describe("CurService", () => {
       mockFetch.mockRejectedValue(error);
 
       // when
-      const promise = curService.uploadFile(file);
+      const promise = curApiClient.uploadFile(file);
 
       // then
       await expect(promise).rejects.toThrow("Failed to get presigned URL");
@@ -138,7 +138,7 @@ describe("CurService", () => {
       mockGlobalFetch.mockRejectedValue(error);
 
       // when
-      const promise = curService.uploadFile(file);
+      const promise = curApiClient.uploadFile(file);
 
       // then
       await expect(promise).rejects.toThrow("S3 upload failed");
diff --git a/test/stores/cloud-service-provider.store.spec.ts b/test/stores/cloud-service-provider.store.spec.ts
@@ -35,7 +35,7 @@ const { mockGetCloudServiceProviders } = vi.hoisted(() => ({
 mockNuxtImport("useNuxtApp", () => {
   return () => ({
     $api: {
-      cloudServiceProviderService: {
+      cloudServiceProviderApiClient: {
         getCloudServiceProviders: mockGetCloudServiceProviders,
       },
     },
diff --git a/test/stores/infrastructure.store.spec.ts b/test/stores/infrastructure.store.spec.ts

Original file line number	Diff line number	Diff line change
`@@ -97,7 +97,7 @@ function deleteInfrastructure(infrastructure: Infrastructure) {`
`97`	`97`	`}`
`98`	`98`
`99`	`99`	`async function confirmInfrastructureDeletion(infrastructure: Infrastructure) {`
`100`		`- await $api.infrastructureService.deleteInfra(infrastructure.id!);`
	`100`	`+ await $api.infrastructureApiClient.deleteInfra(infrastructure.id!);`
`101`	`101`	`await infrastructuresStore.fetchInfrastructures();`
`102`	`102`	`}`
`103`	`103`