feat: add useGetResourceKindsOptions for resource list

Author: eshankvaish

src/Shared/Hooks/index.ts

@@ -15,3 +15,4 @@
  */
 
 export * from './UsePrompt'
+export * from './useGetResourceKindsOptions'

src/Shared/Hooks/useGetResourceKindsOptions/index.ts

@@ -0,0 +1,2 @@
+export { default as useGetResourceKindsOptions } from './useGetResourceKindsOptions'
+export type { UseGetResourceKindsOptionsProps, UseGetResourceKindOptionsReturnType } from './types'

src/Shared/Hooks/useGetResourceKindsOptions/service.ts

@@ -0,0 +1,52 @@
+import { ResponseType, Teams } from '@Common/Types'
+import { getTeamListMin } from '@Common/Common.service'
+import { get } from '@Common/Api'
+import { ClusterType } from '@Shared/Services'
+import { EnvironmentType, EnvListMinDTO } from '@Shared/types'
+import { EnvironmentTypeEnum } from '@Shared/constants'
+import { ROUTES } from '@Common/Constants'
+import { AppsGroupedByProjectsType, ClusterDTO } from './types'
+
+export const getAppOptionsGroupedByProjects = async (): Promise<AppsGroupedByProjectsType> => {
+    const { result } = (await get('app/min')) as ResponseType<AppsGroupedByProjectsType>
+
+    return result ?? []
+}
+
+export const getProjectOptions = async (): Promise<Pick<Teams, 'id' | 'name'>[]> => {
+    const { result } = await getTeamListMin()
+
+    return (
+        result?.map(({ id, name }) => ({
+            id,
+            name,
+        })) ?? []
+    )
+}
+
+export const getClusterOptions = async (): Promise<ClusterType[]> => {
+    const { result } = (await get('cluster/autocomplete')) as ResponseType<ClusterDTO[]>
+
+    return (
+        result?.map((cluster) => ({
+            id: cluster.id,
+            name: cluster.cluster_name,
+            isVirtual: cluster.isVirtualCluster ?? false,
+        })) ?? []
+    )
+}
+
+export const getEnvironmentOptions = async (): Promise<EnvironmentType[]> => {
+    const { result } = (await get(ROUTES.ENVIRONMENT_LIST_MIN)) as ResponseType<EnvListMinDTO[]>
+
+    return (
+        result?.map((environment) => ({
+            id: environment.id,
+            name: environment.cluster_name,
+            isVirtual: environment.isVirtualEnvironment ?? false,
+            cluster: environment.cluster_name,
+            environmentType: environment.default ? EnvironmentTypeEnum.production : EnvironmentTypeEnum.nonProduction,
+            namespace: environment.namespace,
+        })) ?? []
+    )
+}

src/Shared/Hooks/useGetResourceKindsOptions/types.ts

@@ -0,0 +1,45 @@
+// ====== Service Types: Start ====== //
+
+import { ResourceKindType } from '@Shared/types'
+import { ServerErrors } from '@Common/ServerError'
+import { getAppOptionsGroupedByProjects, getClusterOptions, getEnvironmentOptions, getProjectOptions } from './service'
+
+export interface AppType {
+    name: string
+}
+
+export type AppsGroupedByProjectsType = {
+    projectId: number
+    projectName: string
+    appList: AppType[]
+}[]
+
+export interface ClusterDTO {
+    id: number
+    cluster_name: string
+    isVirtualCluster: boolean
+}
+
+// ====== Service Types: End ====== //
+
+export interface UseGetResourceKindsOptionsProps {
+    resourcesToFetch: Extract<
+        ResourceKindType,
+        | ResourceKindType.devtronApplication
+        | ResourceKindType.project
+        | ResourceKindType.cluster
+        | ResourceKindType.environment
+    >[]
+}
+
+export interface UseGetResourceKindOptionsReturnType {
+    isResourcesOptionsLoading: boolean
+    resourcesOptionsMap: {
+        [ResourceKindType.devtronApplication]: Awaited<ReturnType<typeof getAppOptionsGroupedByProjects>>
+        [ResourceKindType.project]: Awaited<ReturnType<typeof getProjectOptions>>
+        [ResourceKindType.cluster]: Awaited<ReturnType<typeof getClusterOptions>>
+        [ResourceKindType.environment]: Awaited<ReturnType<typeof getEnvironmentOptions>>
+    }
+    resourcesOptionsError: ServerErrors
+    refetchResourcesOptions: () => void
+}

src/Shared/Hooks/useGetResourceKindsOptions/useGetResourceKindsOptions.tsx

@@ -0,0 +1,49 @@
+import { useMemo } from 'react'
+import { ResourceKindType } from '@Shared/types'
+import { useAsync } from '@Common/Helper'
+import { getAppOptionsGroupedByProjects, getClusterOptions, getEnvironmentOptions, getProjectOptions } from './service'
+import { UseGetResourceKindOptionsReturnType, UseGetResourceKindsOptionsProps } from './types'
+import { getResourcesToFetchMap } from './utils'
+
+/**
+ * Generic hook to fetch the options list for the supported resource kinds.
+ *
+ * Note: no call would be made for empty resource kind list
+ *
+ * @example Usage
+ * ```tsx
+ * const data = useGetResourceKindsOptions({
+ *      resourcesToFetch: [ResourceKindType.devtronApplication, ResourceKindType.environment]
+ * })
+ * ```
+ */
+const useGetResourceKindsOptions = ({
+    resourcesToFetch,
+}: UseGetResourceKindsOptionsProps): UseGetResourceKindOptionsReturnType => {
+    const resourcesToFetchMap = useMemo(() => getResourcesToFetchMap(resourcesToFetch), [resourcesToFetch])
+    const [isResourcesOptionsLoading, resourcesOptions, resourcesOptionsError, refetchResourcesOptions] = useAsync(
+        () =>
+            Promise.all([
+                resourcesToFetchMap[ResourceKindType.devtronApplication] ? getAppOptionsGroupedByProjects() : null,
+                resourcesToFetchMap[ResourceKindType.project] ? getProjectOptions() : null,
+                resourcesToFetchMap[ResourceKindType.cluster] ? getClusterOptions() : null,
+                resourcesToFetchMap[ResourceKindType.environment] ? getEnvironmentOptions() : null,
+            ]),
+        [resourcesToFetchMap],
+        resourcesToFetch.length > 0,
+    )
+
+    return {
+        isResourcesOptionsLoading,
+        resourcesOptionsMap: {
+            [ResourceKindType.devtronApplication]: resourcesOptions?.[0] ?? [],
+            [ResourceKindType.project]: resourcesOptions?.[1] ?? [],
+            [ResourceKindType.cluster]: resourcesOptions?.[2] ?? [],
+            [ResourceKindType.environment]: resourcesOptions?.[3] ?? [],
+        },
+        resourcesOptionsError,
+        refetchResourcesOptions,
+    }
+}
+
+export default useGetResourceKindsOptions

src/Shared/Hooks/useGetResourceKindsOptions/utils.ts

@@ -0,0 +1,17 @@
+import { ResourceKindType } from '@Shared/types'
+import { UseGetResourceKindsOptionsProps } from './types'
+
+export const getResourcesToFetchMap = (resourcesToFetch: UseGetResourceKindsOptionsProps['resourcesToFetch']) =>
+    resourcesToFetch.reduce<Record<UseGetResourceKindsOptionsProps['resourcesToFetch'][0], boolean>>(
+        (acc, resource) => {
+            acc[resource] = true
+
+            return acc
+        },
+        {
+            [ResourceKindType.devtronApplication]: false,
+            [ResourceKindType.project]: false,
+            [ResourceKindType.cluster]: false,
+            [ResourceKindType.environment]: false,
+        },
+    )