farhan/feat: add useSettings hook to @deriv/api (deriv-com#9805)

* chore: added useSettings to @deriv/api

* chore: combine get_settings with set_settings

* refactor: change function name

* chore: return all mutation data

* chore: export hook

* refactor: types and mutation function name

packages/api/src/hooks/index.ts

@@ -4,5 +4,6 @@ export { default as useAuthorize } from './useAuthorize';
 export { default as useBalance } from './useBalance';
 export { default as useCurrencyConfig } from './useCurrencyConfig';
 export { default as useMT5LoginList } from './useMT5LoginList';
+export { default as useSettings } from './useSettings';
 export { default as useTradingPlatformAccounts } from './useTradingPlatformAccounts';
 export { default as useWalletAccountsList } from './useWalletAccountsList';

packages/api/src/hooks/useSettings.ts

@@ -0,0 +1,32 @@
+import { useCallback, useMemo } from 'react';
+import useFetch from '../useFetch';
+import useInvalidateQuery from '../useInvalidateQuery';
+import useRequest from '../useRequest';
+
+type TSetSettingsPayload = NonNullable<
+    NonNullable<NonNullable<Parameters<ReturnType<typeof useRequest<'set_settings'>>['mutate']>>[0]>['payload']
+>;
+
+/** A custom hook to get user settings (email, date of birth, address etc) */
+const useSettings = () => {
+    const { data, ...rest } = useFetch('get_settings');
+    const invalidate = useInvalidateQuery();
+    const { mutate, ...mutate_rest } = useRequest('set_settings', {
+        onSuccess: () => invalidate('get_settings'),
+    });
+
+    const update = useCallback((values: TSetSettingsPayload) => mutate({ payload: { ...values } }), [mutate]);
+
+    const modified_data = useMemo(() => ({ ...data?.get_settings }), [data?.get_settings]);
+
+    return {
+        /** User information and settings */
+        data: modified_data,
+        /** Function to update user settings */
+        update,
+        mutation: mutate_rest,
+        ...rest,
+    };
+};
+
+export default useSettings;