Merge pull request #3174 from Infisical/feat/addFolderDescription

Add descriptions to secret folders

frontend/src/hooks/api/secretFolders/queries.tsx

@@ -148,12 +148,13 @@ export const useUpdateFolder = () => {
   const queryClient = useQueryClient();
 
   return useMutation<object, object, TUpdateFolderDTO>({
-    mutationFn: async ({ path = "/", folderId, name, environment, projectId }) => {
+    mutationFn: async ({ path = "/", folderId, name, environment, projectId, description }) => {
       const { data } = await apiRequest.patch(`/api/v1/folders/${folderId}`, {
         name,
         environment,
         workspaceId: projectId,
-        path
+        path,
+        description
       });
       return data;
     },

frontend/src/hooks/api/secretFolders/types.ts

@@ -5,6 +5,7 @@ export enum ReservedFolders {
 export type TSecretFolder = {
   id: string;
   name: string;
+  description?: string;
 };
 
 export type TGetProjectFoldersDTO = {
@@ -24,6 +25,7 @@ export type TCreateFolderDTO = {
   environment: string;
   name: string;
   path?: string;
+  description?: string | null;
 };
 
 export type TUpdateFolderDTO = {
@@ -32,6 +34,7 @@ export type TUpdateFolderDTO = {
   name: string;
   folderId: string;
   path?: string;
+  description?: string | null;
 };
 
 export type TDeleteFolderDTO = {
@@ -49,5 +52,6 @@ export type TUpdateFolderBatchDTO = {
     environment: string;
     id: string;
     path?: string;
+    description?: string | null;
   }[];
 };

frontend/src/hooks/utils/secrets-overview.tsx

@@ -2,13 +2,22 @@ import { useCallback, useMemo } from "react";
 
 import { DashboardProjectSecretsOverview } from "@app/hooks/api/dashboard/types";
 
+type FolderNameAndDescription = {
+  name: string;
+  description?: string;
+};
+
 export const useFolderOverview = (folders: DashboardProjectSecretsOverview["folders"]) => {
-  const folderNames = useMemo(() => {
-    const names = new Set<string>();
+  const folderNamesAndDescriptions = useMemo(() => {
+    const namesAndDescriptions = new Map<string, FolderNameAndDescription>();
+  
     folders?.forEach((folder) => {
-      names.add(folder.name);
+      if (!namesAndDescriptions.has(folder.name)) {
+        namesAndDescriptions.set(folder.name, { name: folder.name, description: folder.description });
+      }
     });
-    return [...names];
+  
+    return Array.from(namesAndDescriptions.values());
   }, [folders]);
 
   const isFolderPresentInEnv = useCallback(
@@ -31,7 +40,7 @@ export const useFolderOverview = (folders: DashboardProjectSecretsOverview["fold
     [folders]
   );
 
-  return { folderNames, isFolderPresentInEnv, getFolderByNameAndEnv };
+  return { folderNamesAndDescriptions, isFolderPresentInEnv, getFolderByNameAndEnv };
 };
 
 export const useDynamicSecretOverview = (