feat: add favorites management

packages/apps/dms/src/api/document-api.js

@@ -266,3 +266,19 @@ export async function countAttachedFiles({model, modelId}) {
     provider: 'model',
   });
 }
+
+export async function addToFavorites({documentId}) {
+  return getActionApi().send({
+    url: `ws/aos/dms/favorites/${documentId}`,
+    method: 'post',
+    description: 'add to favorites',
+  });
+}
+
+export async function removeFromFavorites({documentId}) {
+  return getActionApi().send({
+    url: `ws/aos/dms/favorites/${documentId}`,
+    method: 'delete',
+    description: 'remove from favorites',
+  });
+}

packages/apps/dms/src/api/index.ts

@@ -17,9 +17,11 @@
  */
 
 export {
+  addToFavorites as addToFavoritesApi,
   countAttachedFiles as countAttachedDocumentsApi,
   createDocument as createDocumentApi,
   fetchDirectory as fetchDirectoryApi,
+  removeFromFavorites as removeFromFavoritesApi,
   searchDirectory as searchDirectoryApi,
   searchDocument as searchDocumentApi,
   updateDocument as updateDocumentApi,

packages/apps/dms/src/components/molecules/DocumentActionCard/DocumentActionCard.tsx

@@ -16,13 +16,18 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-import React from 'react';
+import React, {useMemo} from 'react';
 import {
+  useDispatch,
   useNavigation,
   useSelector,
   useTranslator,
 } from '@axelor/aos-mobile-core';
 import {ActionCard, useThemeColor} from '@axelor/aos-mobile-ui';
+import {
+  addToFavorites,
+  removeFromFavorites,
+} from '../../../features/documentSlice';
 import {DocumentCard} from '../../atoms';
 
 interface DocumentActionCardProps {
@@ -33,8 +38,20 @@ const DocumentActionCard = ({document}: DocumentActionCardProps) => {
   const I18n = useTranslator();
   const Colors = useThemeColor();
   const navigation = useNavigation();
+  const dispatch = useDispatch();
 
   const {mobileSettings} = useSelector((state: any) => state.appConfig);
+  const {user} = useSelector(state => state.user);
+
+  const isFavorite = useMemo(
+    () => user?.favouriteFileSet.some(({id}) => id === document.id),
+    [document.id, user?.favouriteFileSet],
+  );
+
+  const sliceFunction = useMemo(
+    () => (isFavorite ? removeFromFavorites : addToFavorites),
+    [isFavorite],
+  );
 
   return (
     <ActionCard
@@ -47,10 +64,16 @@ const DocumentActionCard = ({document}: DocumentActionCardProps) => {
           hidden: !mobileSettings?.isDownloadAllowed,
         },
         {
-          iconName: 'star',
+          iconName: isFavorite ? 'star-fill' : 'star',
           iconColor: Colors.progressColor.background,
           helper: I18n.t('Dms_AddToFavorites'),
-          onPress: () => console.log('Add to favorites'),
+          onPress: () =>
+            dispatch(
+              (sliceFunction as any)({
+                documentId: document.id,
+                userId: user?.id,
+              }),
+            ),
           hidden: !mobileSettings?.isFavoritesManagementEnabled,
         },
         {

packages/apps/dms/src/components/templates/DocumentList/DocumentList.tsx

@@ -20,11 +20,17 @@ import React, {useMemo, useState} from 'react';
 import {
   SearchTreeView,
   useNavigation,
+  useDispatch,
   useSelector,
   useTranslator,
 } from '@axelor/aos-mobile-core';
 import {ChipSelect, Screen, useThemeColor} from '@axelor/aos-mobile-ui';
-import {searchDocument, searchDirectory} from '../../../features/documentSlice';
+import {
+  addToFavorites,
+  removeFromFavorites,
+  searchDocument,
+  searchDirectory,
+} from '../../../features/documentSlice';
 import {searchDocumentApi} from '../../../api';
 import {AuthorFilter, DirectoryCard} from '../../atoms';
 import {DocumentActionCard} from '../../molecules';
@@ -38,6 +44,7 @@ const DocumentList = ({defaultParent}: DocumentListProps) => {
   const I18n = useTranslator();
   const Colors = useThemeColor();
   const navigation = useNavigation();
+  const dispatch = useDispatch();
 
   const [author, setAuthor] = useState(null);
   const [selectedExtensions, setSelectedExtensions] = useState([]);
@@ -50,6 +57,7 @@ const DocumentList = ({defaultParent}: DocumentListProps) => {
     directoryList,
   } = useSelector((state: any) => state.dms_document);
   const {mobileSettings} = useSelector((state: any) => state.appConfig);
+  const {user} = useSelector(state => state.user);
 
   const sliceParentFunctionData = useMemo(
     () => ({
@@ -93,30 +101,46 @@ const DocumentList = ({defaultParent}: DocumentListProps) => {
         searchPlaceholder={I18n.t('Base_Search')}
         parentFieldName="parent"
         renderBranch={({item}) => <DirectoryCard directory={item} />}
-        getBranchActions={branch => [
-          {
-            iconName: 'star',
-            iconColor: Colors.progressColor.background,
-            helper: I18n.t('Dms_AddToFavorites'),
-            onPress: () => console.log('branch: ', branch),
-            hidden: !mobileSettings?.isFavoritesManagementEnabled,
-          },
-          {
-            iconName: 'info-circle',
-            helper: I18n.t('Dms_Details'),
-            onPress: () => console.log('branch: ', branch),
-          },
-          {
-            iconName: 'pencil-fill',
-            helper: I18n.t('Dms_Rename'),
-            large: true,
-            onPress: () =>
-              navigation.navigate('DocumentFormScreen', {
-                document: branch.item,
-              }),
-            hidden: !mobileSettings?.isRenamingAllowed,
-          },
-        ]}
+        getBranchActions={branch => {
+          const isFavorite = user?.favouriteFolderSet.some(
+            ({id}) => id === branch.item.id,
+          );
+
+          const sliceFunction = isFavorite
+            ? removeFromFavorites
+            : addToFavorites;
+
+          return [
+            {
+              iconName: isFavorite ? 'star-fill' : 'star',
+              iconColor: Colors.progressColor.background,
+              helper: I18n.t('Dms_AddToFavorites'),
+              onPress: () =>
+                dispatch(
+                  (sliceFunction as any)({
+                    documentId: branch.item.id,
+                    userId: user?.id,
+                  }),
+                ),
+              hidden: !mobileSettings?.isFavoritesManagementEnabled,
+            },
+            {
+              iconName: 'info-circle',
+              helper: I18n.t('Dms_Details'),
+              onPress: () => console.log('branch: ', branch),
+            },
+            {
+              iconName: 'pencil-fill',
+              helper: I18n.t('Dms_Rename'),
+              large: true,
+              onPress: () =>
+                navigation.navigate('DocumentFormScreen', {
+                  document: branch.item,
+                }),
+              hidden: !mobileSettings?.isRenamingAllowed,
+            },
+          ];
+        }}
         renderLeaf={({item}) => <DocumentActionCard document={item} />}
         headerChildren={<AuthorFilter author={author} setAuthor={setAuthor} />}
         chipComponent={

packages/apps/dms/src/features/asyncFunctions-index.ts

@@ -17,8 +17,11 @@
  */
 
 export {
+  addToFavorites,
   createDocument,
+  removeFromFavorites,
   searchDirectory,
   searchDocument,
+  searchFavoriteDocument,
   updateDocument,
 } from './documentSlice';

packages/apps/dms/src/features/documentSlice.js

@@ -18,11 +18,14 @@
 
 import {createAsyncThunk, createSlice} from '@reduxjs/toolkit';
 import {
+  fetchActiveUser,
   generateInifiniteScrollCases,
   handlerApiCall,
 } from '@axelor/aos-mobile-core';
 import {
+  addToFavorites as _addToFavorites,
   createDocument as _createDocument,
+  removeFromFavorites as _removeFromFavorites,
   searchDirectory as _searchDirectory,
   searchDocument as _searchDocument,
   updateDocument as _updateDocument,
@@ -93,6 +96,32 @@ export const updateDocument = createAsyncThunk(
   },
 );
 
+export const addToFavorites = createAsyncThunk(
+  'dms_document/addToFavorites',
+  async function (data, {getState, dispatch}) {
+    return handlerApiCall({
+      fetchFunction: _addToFavorites,
+      data,
+      action: 'Dms_SliceAction_AddToFavorites',
+      getState,
+      responseOptions: {isArrayResponse: false, showToast: true},
+    }).then(() => dispatch(fetchActiveUser(data.userId)));
+  },
+);
+
+export const removeFromFavorites = createAsyncThunk(
+  'dms_document/removeFromFavorites',
+  async function (data, {getState, dispatch}) {
+    return handlerApiCall({
+      fetchFunction: _removeFromFavorites,
+      data,
+      action: 'Dms_SliceAction_RemoveFromFavorites',
+      getState,
+      responseOptions: {isArrayResponse: false, showToast: true},
+    }).then(() => dispatch(fetchActiveUser(data.userId)));
+  },
+);
+
 const initialState = {
   loadingDocuments: false,
   moreLoadingDocument: false,

packages/apps/dms/src/i18n/en.json

@@ -23,5 +23,7 @@
   "Dms_SliceAction_CreateDocument": "create document",
   "Dms_SliceAction_UpdateDocument": "update document",
   "Dms_SliceAction_FetchDirectory": "fetch directory",
-  "Dms_SliceAction_CountAttachedFiles": "count attached files"
+  "Dms_SliceAction_CountAttachedFiles": "count attached files",
+  "Dms_SliceAction_AddToFavorites": "add to favorites",
+  "Dms_SliceAction_RemoveFromFavorites": "remove from favorites"
 }

packages/apps/dms/src/i18n/fr.json

@@ -23,5 +23,7 @@
   "Dms_SliceAction_CreateDocument": "création d'un document",
   "Dms_SliceAction_UpdateDocument": "mise à jour d'un document",
   "Dms_SliceAction_FetchDirectory": "récupération d'un dossier",
-  "Dms_SliceAction_CountAttachedFiles": "comptage des fichiers joints"
+  "Dms_SliceAction_CountAttachedFiles": "comptage des fichiers joints",
+  "Dms_SliceAction_AddToFavorites": "ajout aux favoris",
+  "Dms_SliceAction_RemoveFromFavorites": "suppression des favoris"
 }