revert: docs: Add TypeScript typings to LmsApiService group methods

package.json

@@ -91,7 +91,6 @@
   },
   "devDependencies": {
     "@edx/browserslist-config": "1.5.0",
-    "@edx/typescript-config": "1.1.0",
     "@faker-js/faker": "^7.6.0",
     "@openedx/frontend-build": "14.2.2",
     "@testing-library/dom": "9.3.4",

src/components/learner-credit-management/data/hooks/tests/useEnterpriseGroup.test.jsx

@@ -27,7 +27,7 @@ describe('useEnterpriseGroup', () => {
   it('should fetch and return enterprise group', async () => {
     jest.spyOn(LmsApiService, 'fetchEnterpriseGroup').mockResolvedValueOnce({
       data: {
-        enterpriseCustomer: 'customer-uuid',
+        enterprise_customer: 'customer-uuid',
         name: 'groupidy group',
         uuid: 'group-uuid',
       },
@@ -47,7 +47,7 @@ describe('useEnterpriseGroup', () => {
   it('should return null if no group associations are listed', async () => {
     jest.spyOn(LmsApiService, 'fetchEnterpriseGroup').mockResolvedValueOnce({
       data: {
-        enterpriseCustomer: 'customer-uuid',
+        enterprise_customer: 'customer-uuid',
         name: 'groupidy group',
         uuid: 'group-uuid',
       },

src/components/learner-credit-management/data/hooks/useEnterpriseGroup.js

@@ -1,4 +1,5 @@
 import { useQuery } from '@tanstack/react-query';
+import { camelCaseObject } from '@edx/frontend-platform/utils';
 import isEmpty from 'lodash/isEmpty';
 
 import { learnerCreditManagementQueryKeys } from '../constants';
@@ -15,7 +16,8 @@ const getEnterpriseGroup = async ({ subsidyAccessPolicy }) => {
     return null;
   }
   const response = await LmsApiService.fetchEnterpriseGroup(subsidyAccessPolicy.groupAssociations[0]);
-  return response.data;
+  const enterpriseGroup = camelCaseObject(response.data);
+  return enterpriseGroup;
 };
 
 const useEnterpriseGroup = (subsidyAccessPolicy, { queryOptions } = {}) => useQuery({

src/data/services/LmsApiService.ts → src/data/services/LmsApiService.js

@@ -1,25 +1,8 @@
 import { getAuthenticatedHttpClient } from '@edx/frontend-platform/auth';
 import { camelCaseObject } from '@edx/frontend-platform/utils';
-import type { AxiosResponse } from 'axios';
 
 import { configuration } from '../../config';
 import generateFormattedStatusUrl from './apiServiceUtils';
-import { EnterpriseGroup, PaginatedCurrentPage } from '../../types';
-
-export type CreateEnterpriseGroupArgs = {
-  /* The name of the group to create */
-  groupName: string,
-  /* The uuid of the new group's enterprise customer */
-  enterpriseUUID: string
-};
-
-export type UpdateEnterpriseGroupArgs = {
-  /* The updated name of the group */
-  name: string,
-};
-
-export type EnterpriseGroupResponse = Promise<AxiosResponse<EnterpriseGroup>>;
-export type EnterpriseGroupListResponse = Promise<AxiosResponse<PaginatedCurrentPage<EnterpriseGroup>>>;
 
 class LmsApiService {
   static apiClient = getAuthenticatedHttpClient;
@@ -66,14 +49,14 @@ class LmsApiService {
 
   static enterpriseLearnerUrl = `${LmsApiService.baseUrl}/enterprise/api/v1/enterprise-learner/`;
 
-  static createEnterpriseGroup({ groupName, enterpriseUUID }: CreateEnterpriseGroupArgs): EnterpriseGroup {
+  static createEnterpriseGroup(options) {
     const postParams = {
-      name: groupName,
-      enterprise_customer: enterpriseUUID,
+      name: options.groupName,
+      enterprise_customer: options.enterpriseUUID,
       members: [],
     };
     const createEnterpriseGroupUrl = `${LmsApiService.enterpriseGroupListUrl}`;
-    return camelCaseObject(LmsApiService.apiClient().post(createEnterpriseGroupUrl, postParams));
+    return LmsApiService.apiClient().post(createEnterpriseGroupUrl, postParams);
   }
 
   static fetchEnterpriseSsoOrchestrationRecord(configurationUuid) {
@@ -445,7 +428,7 @@ class LmsApiService {
     );
   };
 
-  static async fetchData(url, linkedEnterprises: any[] = []) {
+  static async fetchData(url, linkedEnterprises = []) {
     const response = await getAuthenticatedHttpClient().get(url);
     const responseData = camelCaseObject(response.data);
     const linkedEnterprisesCopy = [...linkedEnterprises];
@@ -466,18 +449,14 @@ class LmsApiService {
     return response;
   };
 
-  static fetchEnterpriseGroup = async (groupUuid: string): EnterpriseGroupResponse => {
+  static fetchEnterpriseGroup = async (groupUuid) => {
     const groupEndpoint = `${LmsApiService.enterpriseGroupListUrl}${groupUuid}/`;
-    const response = LmsApiService.apiClient().get(groupEndpoint);
-    response.data = camelCaseObject(response.data);
-    return response;
+    return LmsApiService.apiClient().get(groupEndpoint);
   };
 
-  static fetchEnterpriseGroups = async (): EnterpriseGroupListResponse => {
+  static fetchEnterpriseGroups = async () => {
     const url = `${LmsApiService.enterpriseGroupUrl}`;
-    const response = LmsApiService.apiClient().get(url);
-    response.data = camelCaseObject(response.data);
-    return response;
+    return LmsApiService.apiClient().get(url);
   };
 
   static inviteEnterpriseLearnersToGroup = async (groupUuid, formData) => {
@@ -496,26 +475,21 @@ class LmsApiService {
 
   static fetchAllEnterpriseGroupLearners = async (groupUuid) => {
     const queryParams = new URLSearchParams({
-      page: '1',
+      page: 1,
     });
     const url = `${LmsApiService.enterpriseGroupUrl}${groupUuid}/learners?${queryParams.toString()}`;
     const response = await LmsApiService.fetchData(url);
     return response;
   };
 
-  static removeEnterpriseGroup = async (groupUuid: string): Promise<AxiosResponse> => {
+  static removeEnterpriseGroup = async (groupUuid) => {
     const removeGroupEndpoint = `${LmsApiService.enterpriseGroupListUrl}${groupUuid}/`;
     return LmsApiService.apiClient().delete(removeGroupEndpoint);
   };
 
-  static updateEnterpriseGroup = async (
-    groupUuid: string,
-    formData: UpdateEnterpriseGroupArgs,
-  ): EnterpriseGroupResponse => {
+  static updateEnterpriseGroup = async (groupUuid, formData) => {
     const updateGroupEndpoint = `${LmsApiService.enterpriseGroupListUrl}${groupUuid}/`;
-    const response = LmsApiService.apiClient().patch(updateGroupEndpoint, formData);
-    response.data = camelCaseObject(response.data);
-    return response;
+    return LmsApiService.apiClient().patch(updateGroupEndpoint, formData);
   };
 
   static removeEnterpriseLearnersFromGroup = async (groupUuid, formData) => {

src/data/services/tests/LmsApiService.test.js

@@ -109,7 +109,7 @@ describe('LmsApiService', () => {
       data: {
         uuid: 'test-uuid',
         name: 'test-name',
-        enterpriseCustomer: 'test-enterprise-customer',
+        enterprise_customer: 'test-enterprise-customer',
         members: [],
       },
     });

tsconfig.json

@@ -1,9 +1,27 @@
 {
-  "extends": "@edx/typescript-config",
   "compilerOptions": {
+    "allowJs": true,
+    "allowSyntheticDefaultImports": true,
+    "declaration": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "jsx": "react",
+    "lib": ["dom", "es6", "dom.iterable"],
+    "isolatedModules": true,
+    "module": "ES6",
+    "moduleResolution": "node",
+    "noFallthroughCasesInSwitch": true,
+    "noImplicitAny": false,
+    "noImplicitThis": true,
+    "noUnusedParameters": true,
+    "skipLibCheck": true,
+    "sourceMap": true,
+    "strict": true,
+    "strictFunctionTypes": false,
+    "target": "ES6",
     "rootDir": ".",
-    "outDir": "dist",
+    "outDir": "dist"
   },
   "include": ["src/**/*", "__mocks__/**/*"],
-  "exclude": ["dist", "src/icons/*"],
+  "exclude": ["dist", "src/icons/*"]
 }