From 3601bb52f5ff7d07de65cda83afd52247d2a8cab Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kevin=20Gr=C3=BCneberg?= Date: Fri, 19 Jul 2024 18:35:23 +0800 Subject: [PATCH] chore: use type imports / avoid unnecessary API type export (#28088) --- .../Navigation/NavigationMenu/NavigationMenu.utils.ts | 4 ++-- .../NavigationMenu/NavigationMenuRefListItems.tsx | 2 +- apps/docs/components/reference/OldVersionAlert.tsx | 2 +- apps/docs/components/reference/RefFunctionSection.tsx | 2 +- apps/docs/components/reference/RefSectionHandler.tsx | 2 +- apps/docs/components/reference/Reference.types.ts | 2 +- apps/docs/generator/api.ts | 2 +- apps/docs/lib/fetch/fetchWrappers.ts | 2 +- apps/docs/lib/fetch/organizations.ts | 2 +- apps/docs/lib/helpers.ts | 6 +++++- apps/docs/lib/mdx/generateRefMarkdown.tsx | 2 +- apps/docs/lib/mdx/handleRefStaticPaths.tsx | 2 +- apps/docs/lib/mdx/handleRefStaticProps.tsx | 2 +- apps/docs/lib/refGenerator/helpers.ts | 4 ++-- apps/docs/scripts/search/sources/reference-doc.ts | 6 +++--- apps/docs/types/api.d.ts | 4 ---- apps/docs/types/next.ts | 6 +++--- 17 files changed, 26 insertions(+), 26 deletions(-) delete mode 100644 apps/docs/types/api.d.ts diff --git a/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.utils.ts b/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.utils.ts index 4cbca0be36a..e39582af7f7 100644 --- a/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.utils.ts +++ b/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.utils.ts @@ -2,8 +2,8 @@ import { useEffect, useState } from 'react' import { usePathname } from 'next/navigation' -import { ICommonItem } from '~/components/reference/Reference.types' -import { Json } from '~/types' +import type { ICommonItem } from '~/components/reference/Reference.types' +import type { Json } from '~/types' import { menuState } from '../../../hooks/useMenuState' export function getPathWithoutHash(relativePath: string) { diff --git a/apps/docs/components/Navigation/NavigationMenu/NavigationMenuRefListItems.tsx b/apps/docs/components/Navigation/NavigationMenu/NavigationMenuRefListItems.tsx index 80ba4217cbf..4d42b905c1d 100644 --- a/apps/docs/components/Navigation/NavigationMenu/NavigationMenuRefListItems.tsx +++ b/apps/docs/components/Navigation/NavigationMenu/NavigationMenuRefListItems.tsx @@ -6,7 +6,7 @@ import Image from 'next/legacy/image' import { Fragment, memo } from 'react' import { cn } from 'ui' import RevVersionDropdown from '~/components/RefVersionDropdown' -import { ICommonItem, ICommonSection } from '~/components/reference/Reference.types' +import type { ICommonItem, ICommonSection } from '~/components/reference/Reference.types' import { menuState, useMenuActiveRefId } from '~/hooks/useMenuState' import { BASE_PATH } from '~/lib/constants' import MenuIconPicker from './MenuIconPicker' diff --git a/apps/docs/components/reference/OldVersionAlert.tsx b/apps/docs/components/reference/OldVersionAlert.tsx index d1f1c28e86a..5c3f4a04664 100644 --- a/apps/docs/components/reference/OldVersionAlert.tsx +++ b/apps/docs/components/reference/OldVersionAlert.tsx @@ -3,7 +3,7 @@ import { usePathname } from 'next/navigation' import { Admonition } from 'ui-patterns/admonition' import { useMenuActiveRefId } from '~/hooks/useMenuState' -import { ICommonSection } from './Reference.types' +import type { ICommonSection } from './Reference.types' export interface OldVersionAlertProps { sections: ICommonSection[] diff --git a/apps/docs/components/reference/RefFunctionSection.tsx b/apps/docs/components/reference/RefFunctionSection.tsx index 8c9d9fecd8a..0a101e55018 100644 --- a/apps/docs/components/reference/RefFunctionSection.tsx +++ b/apps/docs/components/reference/RefFunctionSection.tsx @@ -7,7 +7,7 @@ import Param from '~/components/Params' import RefDetailCollapse from '~/components/reference/RefDetailCollapse' import RefSubLayout from '~/layouts/ref/RefSubLayout' import { extractTsDocNode, generateParameters } from '~/lib/refGenerator/helpers' -import { IRefFunctionSection } from './Reference.types' +import type { IRefFunctionSection } from './Reference.types' const RefFunctionSection: React.FC = (props) => { const item = props.spec.functions.find((x: any) => x.id === props.funcData.id) diff --git a/apps/docs/components/reference/RefSectionHandler.tsx b/apps/docs/components/reference/RefSectionHandler.tsx index 7ab81c7554b..22174b29be3 100644 --- a/apps/docs/components/reference/RefSectionHandler.tsx +++ b/apps/docs/components/reference/RefSectionHandler.tsx @@ -10,7 +10,7 @@ import RefSubLayout from '~/layouts/ref/RefSubLayout' import ApiOperationSection from './ApiOperationSection' import CliCommandSection from './CLICommandSection' import OldVersionAlert from './OldVersionAlert' -import { IAPISpec, ICommonSection, IRefStaticDoc, ISpec, TypeSpec } from './Reference.types' +import type { IAPISpec, ICommonSection, IRefStaticDoc, ISpec, TypeSpec } from './Reference.types' import { MainSkeleton } from '~/layouts/MainSkeleton' import MgmtApiOperationSection from '~/components/reference/MgmtApiOperationSection' diff --git a/apps/docs/components/reference/Reference.types.ts b/apps/docs/components/reference/Reference.types.ts index e56647d9c18..1a52db858b2 100644 --- a/apps/docs/components/reference/Reference.types.ts +++ b/apps/docs/components/reference/Reference.types.ts @@ -1,4 +1,4 @@ -import { enrichedOperation } from '~/lib/refGenerator/helpers' +import type { enrichedOperation } from '~/lib/refGenerator/helpers' export interface ISpec { openref: any diff --git a/apps/docs/generator/api.ts b/apps/docs/generator/api.ts index f915e422534..1c3c7361199 100644 --- a/apps/docs/generator/api.ts +++ b/apps/docs/generator/api.ts @@ -1,6 +1,6 @@ import template from './templates/ApiTemplate' import { slugify, toArrayWithKey, toTitle, writeToDisk } from './helpers' -import { OpenAPIV3, OpenAPIV2 } from 'openapi-types' +import type { OpenAPIV3, OpenAPIV2 } from 'openapi-types' import * as fs from 'fs' import * as ejs from 'ejs' diff --git a/apps/docs/lib/fetch/fetchWrappers.ts b/apps/docs/lib/fetch/fetchWrappers.ts index d9e8b9e54d4..440ac83dc8b 100644 --- a/apps/docs/lib/fetch/fetchWrappers.ts +++ b/apps/docs/lib/fetch/fetchWrappers.ts @@ -1,4 +1,4 @@ -import { type paths } from '~/types/api' +import type { paths } from 'api-types' import createClient from 'openapi-fetch' import { v4 as uuidv4 } from 'uuid' import { API_URL } from '../constants' diff --git a/apps/docs/lib/fetch/organizations.ts b/apps/docs/lib/fetch/organizations.ts index 40ee51f1861..9db981af8c8 100644 --- a/apps/docs/lib/fetch/organizations.ts +++ b/apps/docs/lib/fetch/organizations.ts @@ -1,6 +1,6 @@ import { useQuery, UseQueryOptions } from '@tanstack/react-query' import { get } from './fetchWrappers' -import type { components } from '~/types/api' +import type { components } from 'api-types' import type { ResponseError } from '~/types/fetch' const organizationKeys = { diff --git a/apps/docs/lib/helpers.ts b/apps/docs/lib/helpers.ts index 112898e065a..81e4a187c93 100644 --- a/apps/docs/lib/helpers.ts +++ b/apps/docs/lib/helpers.ts @@ -1,4 +1,8 @@ -import { ICommonBase, ICommonItem, ICommonSection } from '../components/reference/Reference.types' +import type { + ICommonBase, + ICommonItem, + ICommonSection, +} from '../components/reference/Reference.types' // menus to render in the SideBar.js (Ref Nav.constants.ts) export function getPageType(asPath: string) { diff --git a/apps/docs/lib/mdx/generateRefMarkdown.tsx b/apps/docs/lib/mdx/generateRefMarkdown.tsx index f30bc10f4fc..bda0debbe01 100644 --- a/apps/docs/lib/mdx/generateRefMarkdown.tsx +++ b/apps/docs/lib/mdx/generateRefMarkdown.tsx @@ -5,7 +5,7 @@ import codeHikeTheme from 'config/code-hike.theme.json' assert { type: 'json' } import matter from 'gray-matter' import { serialize } from 'next-mdx-remote/serialize' import remarkGfm from 'remark-gfm' -import { ICommonMarkdown } from '~/components/reference/Reference.types' +import type { ICommonMarkdown } from '~/components/reference/Reference.types' async function generateRefMarkdown(sections: ICommonMarkdown[], slug: string) { let markdownContent = [] diff --git a/apps/docs/lib/mdx/handleRefStaticPaths.tsx b/apps/docs/lib/mdx/handleRefStaticPaths.tsx index 476dce8e22d..344c60256fa 100644 --- a/apps/docs/lib/mdx/handleRefStaticPaths.tsx +++ b/apps/docs/lib/mdx/handleRefStaticPaths.tsx @@ -1,4 +1,4 @@ -import { ICommonSection } from '~/components/reference/Reference.types' +import type { ICommonSection } from '~/components/reference/Reference.types' async function handleRefGetStaticPaths(sections: ICommonSection[]) { // In preview environments, don't generate static pages (faster builds) diff --git a/apps/docs/lib/mdx/handleRefStaticProps.tsx b/apps/docs/lib/mdx/handleRefStaticProps.tsx index 56c6c159ed0..e2f89f678ac 100644 --- a/apps/docs/lib/mdx/handleRefStaticProps.tsx +++ b/apps/docs/lib/mdx/handleRefStaticProps.tsx @@ -1,4 +1,4 @@ -import { ICommonMarkdown, ICommonSection } from '~/components/reference/Reference.types' +import type { ICommonMarkdown, ICommonSection } from '~/components/reference/Reference.types' import generateRefMarkdown from '~/lib/mdx/generateRefMarkdown' async function handleRefStaticProps(sections: ICommonSection[], libraryPath: string) { diff --git a/apps/docs/lib/refGenerator/helpers.ts b/apps/docs/lib/refGenerator/helpers.ts index 6a30f0ad918..1a4eb672b1d 100644 --- a/apps/docs/lib/refGenerator/helpers.ts +++ b/apps/docs/lib/refGenerator/helpers.ts @@ -1,9 +1,9 @@ import { TsDoc } from '../../generator/legacy/definitions' import { values, mapValues } from 'lodash' -import { OpenAPIV3 } from 'openapi-types' +import type { OpenAPIV3 } from 'openapi-types' import { flattenSections } from '../helpers' -import { ICommonItem } from '~/components/reference/Reference.types' +import type { ICommonItem } from '~/components/reference/Reference.types' export function extractTsDocNode(nodeToFind: string, definition: any) { const nodePath = nodeToFind.split('.') diff --git a/apps/docs/scripts/search/sources/reference-doc.ts b/apps/docs/scripts/search/sources/reference-doc.ts index 8b50e898a30..efb54e6bcdc 100644 --- a/apps/docs/scripts/search/sources/reference-doc.ts +++ b/apps/docs/scripts/search/sources/reference-doc.ts @@ -1,14 +1,14 @@ import { createHash } from 'crypto' import { readFile } from 'fs/promises' import yaml from 'js-yaml' -import { OpenAPIV3 } from 'openapi-types' -import { +import type { OpenAPIV3 } from 'openapi-types' +import type { ICommonItem, ICommonSection, IFunctionDefinition, ISpec, } from '../../../components/reference/Reference.types' -import { CliCommand, CliSpec } from '../../../generator/types/CliSpec' +import type { CliCommand, CliSpec } from '../../../generator/types/CliSpec' import { flattenSections } from '../../../lib/helpers' import { enrichedOperation, gen_v3 } from '../../../lib/refGenerator/helpers' import type { Json } from '../../helpers.mdx' diff --git a/apps/docs/types/api.d.ts b/apps/docs/types/api.d.ts deleted file mode 100644 index ef41f7bc31e..00000000000 --- a/apps/docs/types/api.d.ts +++ /dev/null @@ -1,4 +0,0 @@ -/** - * Avoid importing this file and import the types directly from api-types - */ -export * from 'api-types' diff --git a/apps/docs/types/next.ts b/apps/docs/types/next.ts index b525bed86bc..a8c464c01fa 100644 --- a/apps/docs/types/next.ts +++ b/apps/docs/types/next.ts @@ -1,6 +1,6 @@ -import { NextPage } from 'next' -import { AppProps } from 'next/app' -import { ReactElement, ReactNode } from 'react' +import type { NextPage } from 'next' +import type { AppProps } from 'next/app' +import type { ReactElement, ReactNode } from 'react' export type AppPropsWithLayout = AppProps & { Component: NextPageWithLayout