From 8d712972dc53e00ef9d411a1d7b3ff919a53027a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=B4mulo=20Penido?= Date: Tue, 25 Jun 2024 10:29:01 -0300 Subject: [PATCH] fix: remove @ts-check and move CreateContentLibraryArgs type --- src/library-authoring/EmptyStates.tsx | 1 - src/library-authoring/LibraryAuthoringPage.test.tsx | 1 - src/library-authoring/LibraryAuthoringPage.tsx | 1 - src/library-authoring/LibraryCollections.tsx | 1 - src/library-authoring/LibraryComponents.tsx | 1 - src/library-authoring/LibraryHome.tsx | 1 - .../create-library/CreateLibrary.test.tsx | 1 - .../create-library/CreateLibrary.tsx | 5 ++--- src/library-authoring/create-library/data/api.ts | 11 +++++++---- src/library-authoring/create-library/data/apiHooks.ts | 1 - src/library-authoring/create-library/data/types.d.ts | 5 ----- src/library-authoring/create-library/messages.ts | 1 - src/library-authoring/data/api.ts | 1 - src/library-authoring/data/apiHook.ts | 1 - src/library-authoring/index.ts | 1 - src/library-authoring/messages.ts | 1 - 16 files changed, 9 insertions(+), 25 deletions(-) delete mode 100644 src/library-authoring/create-library/data/types.d.ts diff --git a/src/library-authoring/EmptyStates.tsx b/src/library-authoring/EmptyStates.tsx index 54e3b8019d..d7b718c71d 100644 --- a/src/library-authoring/EmptyStates.tsx +++ b/src/library-authoring/EmptyStates.tsx @@ -1,4 +1,3 @@ -// @ts-check import React from 'react'; import { FormattedMessage } from '@edx/frontend-platform/i18n'; import { diff --git a/src/library-authoring/LibraryAuthoringPage.test.tsx b/src/library-authoring/LibraryAuthoringPage.test.tsx index 15b0d8200c..db7e815a10 100644 --- a/src/library-authoring/LibraryAuthoringPage.test.tsx +++ b/src/library-authoring/LibraryAuthoringPage.test.tsx @@ -1,4 +1,3 @@ -// @ts-check import React from 'react'; import MockAdapter from 'axios-mock-adapter'; import { initializeMockApp } from '@edx/frontend-platform'; diff --git a/src/library-authoring/LibraryAuthoringPage.tsx b/src/library-authoring/LibraryAuthoringPage.tsx index 420ba8d4cf..305c9e753d 100644 --- a/src/library-authoring/LibraryAuthoringPage.tsx +++ b/src/library-authoring/LibraryAuthoringPage.tsx @@ -1,4 +1,3 @@ -// @ts-check import React, { useEffect, useState } from 'react'; import { StudioFooter } from '@edx/frontend-component-footer'; import { useIntl } from '@edx/frontend-platform/i18n'; diff --git a/src/library-authoring/LibraryCollections.tsx b/src/library-authoring/LibraryCollections.tsx index c364ce9a82..2f1eb8951f 100644 --- a/src/library-authoring/LibraryCollections.tsx +++ b/src/library-authoring/LibraryCollections.tsx @@ -1,4 +1,3 @@ -// @ts-check import React from 'react'; import { FormattedMessage } from '@edx/frontend-platform/i18n'; diff --git a/src/library-authoring/LibraryComponents.tsx b/src/library-authoring/LibraryComponents.tsx index 786250a54a..fee8cb3502 100644 --- a/src/library-authoring/LibraryComponents.tsx +++ b/src/library-authoring/LibraryComponents.tsx @@ -1,4 +1,3 @@ -// @ts-check import React from 'react'; import { FormattedMessage } from '@edx/frontend-platform/i18n'; diff --git a/src/library-authoring/LibraryHome.tsx b/src/library-authoring/LibraryHome.tsx index 56e8213353..1201e8a848 100644 --- a/src/library-authoring/LibraryHome.tsx +++ b/src/library-authoring/LibraryHome.tsx @@ -1,4 +1,3 @@ -// @ts-check import React from 'react'; import { FormattedMessage } from '@edx/frontend-platform/i18n'; import { diff --git a/src/library-authoring/create-library/CreateLibrary.test.tsx b/src/library-authoring/create-library/CreateLibrary.test.tsx index 73517f788d..3a473687b4 100644 --- a/src/library-authoring/create-library/CreateLibrary.test.tsx +++ b/src/library-authoring/create-library/CreateLibrary.test.tsx @@ -1,4 +1,3 @@ -// @ts-check import React from 'react'; import MockAdapter from 'axios-mock-adapter'; import { initializeMockApp } from '@edx/frontend-platform'; diff --git a/src/library-authoring/create-library/CreateLibrary.tsx b/src/library-authoring/create-library/CreateLibrary.tsx index 0c4385f3d7..68cd85ba82 100644 --- a/src/library-authoring/create-library/CreateLibrary.tsx +++ b/src/library-authoring/create-library/CreateLibrary.tsx @@ -1,4 +1,3 @@ -// @ts-check import React, { useState } from 'react'; import { StudioFooter } from '@edx/frontend-component-footer'; import { FormattedMessage, useIntl } from '@edx/frontend-platform/i18n'; @@ -19,10 +18,10 @@ import FormikControl from '../../generic/FormikControl'; import FormikErrorFeedback from '../../generic/FormikErrorFeedback'; import { useOrganizationListData } from '../../generic/data/apiHooks'; import SubHeader from '../../generic/sub-header/SubHeader'; +import type { CreateContentLibraryArgs } from './data/api'; import { useCreateLibraryV2 } from './data/apiHooks'; import messages from './messages'; -import type { CreateContentLibraryDto } from './data/types'; const CreateLibrary = () => { const intl = useIntl(); @@ -74,7 +73,7 @@ const CreateLibrary = () => { ), }) } - onSubmit={async (values: CreateContentLibraryDto) => { + onSubmit={async (values: CreateContentLibraryArgs) => { setApiError(undefined); try { const data = await mutateAsync(values); diff --git a/src/library-authoring/create-library/data/api.ts b/src/library-authoring/create-library/data/api.ts index 1587f47517..b5c945db01 100644 --- a/src/library-authoring/create-library/data/api.ts +++ b/src/library-authoring/create-library/data/api.ts @@ -1,9 +1,6 @@ -// @ts-check import { camelCaseObject, getConfig } from '@edx/frontend-platform'; import { getAuthenticatedHttpClient } from '@edx/frontend-platform/auth'; -import type { CreateContentLibraryDto } from './types'; - const getApiBaseUrl = () => getConfig().STUDIO_BASE_URL; /** @@ -11,10 +8,16 @@ const getApiBaseUrl = () => getConfig().STUDIO_BASE_URL; */ export const getContentLibraryV2CreateApiUrl = () => `${getApiBaseUrl()}/api/libraries/v2/`; +export interface CreateContentLibraryArgs { + title: string, + org: string, + slug: string, +} + /** * Create a new library */ -export async function createLibraryV2(data: CreateContentLibraryDto) { +export async function createLibraryV2(data: CreateContentLibraryArgs) { const client = getAuthenticatedHttpClient(); const url = getContentLibraryV2CreateApiUrl(); diff --git a/src/library-authoring/create-library/data/apiHooks.ts b/src/library-authoring/create-library/data/apiHooks.ts index 2e8a9c5004..1dfa498f0f 100644 --- a/src/library-authoring/create-library/data/apiHooks.ts +++ b/src/library-authoring/create-library/data/apiHooks.ts @@ -1,4 +1,3 @@ -// @ts-check import { useMutation, useQueryClient, diff --git a/src/library-authoring/create-library/data/types.d.ts b/src/library-authoring/create-library/data/types.d.ts deleted file mode 100644 index 6428e475a3..0000000000 --- a/src/library-authoring/create-library/data/types.d.ts +++ /dev/null @@ -1,5 +0,0 @@ -export type CreateContentLibraryDto = { - title: string, - org: string, - slug: string, -}; diff --git a/src/library-authoring/create-library/messages.ts b/src/library-authoring/create-library/messages.ts index 2a5a23fb39..295808b56a 100644 --- a/src/library-authoring/create-library/messages.ts +++ b/src/library-authoring/create-library/messages.ts @@ -1,4 +1,3 @@ -// @ts-check import { defineMessages } from '@edx/frontend-platform/i18n'; const messages = defineMessages({ diff --git a/src/library-authoring/data/api.ts b/src/library-authoring/data/api.ts index e78eb92ba5..cc1d568815 100644 --- a/src/library-authoring/data/api.ts +++ b/src/library-authoring/data/api.ts @@ -1,4 +1,3 @@ -// @ts-check import { camelCaseObject, getConfig } from '@edx/frontend-platform'; import { getAuthenticatedHttpClient } from '@edx/frontend-platform/auth'; diff --git a/src/library-authoring/data/apiHook.ts b/src/library-authoring/data/apiHook.ts index d283019082..56a6791d26 100644 --- a/src/library-authoring/data/apiHook.ts +++ b/src/library-authoring/data/apiHook.ts @@ -1,4 +1,3 @@ -// @ts-check import React from 'react'; import { useQuery } from '@tanstack/react-query'; import { MeiliSearch } from 'meilisearch'; diff --git a/src/library-authoring/index.ts b/src/library-authoring/index.ts index 734d6c6584..6cfd692faf 100644 --- a/src/library-authoring/index.ts +++ b/src/library-authoring/index.ts @@ -1,3 +1,2 @@ -// @ts-check export { default as LibraryAuthoringPage } from './LibraryAuthoringPage'; export { CreateLibrary } from './create-library'; diff --git a/src/library-authoring/messages.ts b/src/library-authoring/messages.ts index acb35dfb67..ff2f66c420 100644 --- a/src/library-authoring/messages.ts +++ b/src/library-authoring/messages.ts @@ -1,4 +1,3 @@ -// @ts-check import { defineMessages } from '@edx/frontend-platform/i18n'; const messages = defineMessages({