chore: add useResidenceList hook

Author: thisyahlen-deriv

packages/api/src/hooks/index.ts

@@ -23,6 +23,7 @@ export { default as useDxtradeAccountsList } from './useDxtradeAccountsList';
 export { default as useGetAccountStatus } from './useGetAccountStatus';
 export { default as useLandingCompany } from './useLandingCompany';
 export { default as useMT5AccountsList } from './useMT5AccountsList';
+export { default as useResidenceList } from './useResidenceList';
 export { default as useSettings } from './useSettings';
 export { default as useSortedMT5Accounts } from './useSortedMT5Accounts';
 export { default as useTradingAccountsList } from './useTradingAccountsList';

packages/api/src/hooks/useResidenceList.ts

@@ -0,0 +1,24 @@
+import { useMemo } from 'react';
+import useQuery from '../useQuery';
+
+/** A custom hook that gets the residence list. */
+const useResidenceList = () => {
+    const { data: residence_list, ...residence_list_rest } = useQuery('residence_list');
+
+    /** Modify the residence list data. */
+    const modified_residence_list = useMemo(() => {
+        if (!residence_list || !residence_list.residence_list) return [];
+
+        return residence_list.residence_list.map(residence => ({
+            ...residence,
+        }));
+    }, [residence_list]);
+
+    return {
+        /** The residence list */
+        data: modified_residence_list,
+        ...residence_list_rest,
+    };
+};
+
+export default useResidenceList;