feat: library profile mutations

src/api/index.ts

@@ -19,4 +19,5 @@ export * from './membership';
 export * from './mentions';
 export * from './search';
 export * from './subscription';
+export * from './publicProfile';
 export * from './shortLink';

src/api/publicProfile.ts

@@ -0,0 +1,58 @@
+import { UUID } from '@graasp/sdk';
+
+import { PartialQueryConfigForApi } from '../types';
+import {
+  GET_OWN_PROFILE,
+  MEMBERS_ROUTE,
+  PUBLIC_PROFILE_ROUTE,
+  buildGetPublicProfileRoute,
+} from './routes';
+
+export const getOwnProfile = ({ API_HOST, axios }: PartialQueryConfigForApi) =>
+  axios
+    .get(`${API_HOST}/${MEMBERS_ROUTE}/${GET_OWN_PROFILE}`)
+    .then(({ data }) => data);
+
+export const getPublicProfile = (
+  memberId: UUID,
+  { API_HOST, axios }: PartialQueryConfigForApi,
+) =>
+  axios
+    .get(`${API_HOST}/${MEMBERS_ROUTE}/${buildGetPublicProfileRoute(memberId)}`)
+    .then(({ data }) => data);
+
+export type PostPublicProfilePayloadType = {
+  bio: string;
+  twitterID?: string;
+  facebookID?: string;
+  linkedinID?: string;
+  visibility?: boolean;
+};
+
+export const postPublicProfile = async (
+  {
+    bio,
+    twitterID,
+    facebookID,
+    linkedinID,
+    visibility = false,
+  }: PostPublicProfilePayloadType,
+  { API_HOST, axios }: PartialQueryConfigForApi,
+) =>
+  axios
+    .post(`${API_HOST}/${MEMBERS_ROUTE}/${PUBLIC_PROFILE_ROUTE}`, {
+      bio,
+      twitterID,
+      facebookID,
+      linkedinID,
+      visibility,
+    })
+    .then(({ data }) => data);
+
+export const patchPublicProfile = async (
+  arg: Partial<PostPublicProfilePayloadType>,
+  { API_HOST, axios }: PartialQueryConfigForApi,
+) =>
+  axios
+    .patch(`${API_HOST}/${MEMBERS_ROUTE}/${PUBLIC_PROFILE_ROUTE}`, arg)
+    .then(({ data }) => data);

src/api/routes.ts

@@ -398,6 +398,10 @@ export const buildGetEtherpadRoute = (itemId: UUID) =>
 
 export const SEARCH_PUBLISHED_ITEMS_ROUTE = `${ITEMS_ROUTE}/${COLLECTIONS_ROUTE}/search`;
 
+export const PUBLIC_PROFILE_ROUTE = `profile`;
+export const GET_OWN_PROFILE = `${PUBLIC_PROFILE_ROUTE}/own`;
+export const buildGetPublicProfileRoute = (memberId: UUID) =>
+  `${PUBLIC_PROFILE_ROUTE}/${memberId}`;
 export const buildGetShortLinkAvailableRoute = (alias: string) =>
   `${SHORT_LINKS_ROUTE}/available/${alias}`;
 export const buildGetShortLinksItemRoute = (itemId: string) =>
@@ -516,4 +520,7 @@ export const API_ROUTES = {
   SIGN_OUT_ROUTE,
   SIGN_UP_ROUTE,
   VALIDATION_ROUTE,
+  PUBLIC_PROFILE_ROUTE,
+  GET_OWN_PROFILE,
+  buildGetPublicProfileRoute,
 };

src/config/keys.ts

@@ -256,6 +256,8 @@ export const buildSearchPublishedItemsKey = (args: {
 
 export const CURRENT_MEMBER_STORAGE_KEY = [MEMBERS_KEY, 'current', 'storage'];
 
+export const OWN_PUBLIC_PROFILE_KEY = ['own-profile'];
+export const buildPublicProfileKey = (memberId: UUID) => ['profile', memberId];
 export const DATA_KEYS = {
   APPS_KEY,
   ITEMS_KEY,
@@ -305,4 +307,6 @@ export const DATA_KEYS = {
   buildPublishedItemsKey,
   buildEtherpadKey,
   buildSearchPublishedItemsKey,
+  OWN_PUBLIC_PROFILE_KEY,
+  buildPublicProfileKey,
 };

src/hooks/index.ts

@@ -17,6 +17,7 @@ import configureMemberHooks from './member';
 import configureMembershipHooks from './membership';
 import configureMentionsHooks from './mention';
 import configurePlanHooks from './plan';
+import configurePublicProfileHooks from './publicProfile';
 import configureKeywordSearchHooks from './search';
 import configureShortLinkHooks from './shortLink';
 
@@ -52,6 +53,7 @@ export default (
     ...configureInvitationHooks(queryConfig),
     ...memberHooks,
     ...configurePlanHooks(queryConfig),
+    ...configurePublicProfileHooks(queryConfig),
     ...configureShortLinkHooks(queryConfig),
   };
 };

src/hooks/publicProfile.test.ts

@@ -0,0 +1,81 @@
+import { StatusCodes } from 'http-status-codes';
+import nock from 'nock';
+
+import {
+  MEMBER_PUBLIC_PROFILE,
+  UNAUTHORIZED_RESPONSE,
+} from '../../test/constants';
+import { mockHook, setUpTest } from '../../test/utils';
+import {
+  GET_OWN_PROFILE,
+  MEMBERS_ROUTE,
+  buildGetPublicProfileRoute,
+} from '../api/routes';
+import { OWN_PUBLIC_PROFILE_KEY, buildPublicProfileKey } from '../config/keys';
+
+const { hooks, wrapper, queryClient } = setUpTest();
+
+describe('Public Profile Hooks', () => {
+  afterEach(() => {
+    nock.cleanAll();
+    queryClient.clear();
+  });
+
+  describe('useOwnProfile', () => {
+    const route = `/${MEMBERS_ROUTE}/${GET_OWN_PROFILE}`;
+
+    const response = MEMBER_PUBLIC_PROFILE;
+
+    const hook = () => hooks.useOwnProfile();
+    it(`Receive actions for item id`, async () => {
+      const endpoints = [{ route, response }];
+      const { data } = await mockHook({ endpoints, hook, wrapper });
+      expect(data).toEqual(response);
+      expect(queryClient.getQueryData(OWN_PUBLIC_PROFILE_KEY)).toEqual(
+        response,
+      );
+    });
+
+    it(`Unauthorized`, async () => {
+      const endpoints = [
+        {
+          route,
+          response: UNAUTHORIZED_RESPONSE,
+          statusCode: StatusCodes.UNAUTHORIZED,
+        },
+      ];
+      const { isError } = await mockHook({
+        endpoints,
+        hook,
+        wrapper,
+      });
+
+      expect(isError).toBeTruthy();
+      expect(queryClient.getQueryData(OWN_PUBLIC_PROFILE_KEY)).toBeFalsy();
+    });
+  });
+
+  describe('usePublicProfile', () => {
+    const id = 'member-id';
+    const response = MEMBER_PUBLIC_PROFILE;
+
+    it(`Receive member public profile for member-id = ${id}`, async () => {
+      const endpoints = [
+        {
+          route: `/${MEMBERS_ROUTE}/${buildGetPublicProfileRoute(id)}`,
+          response,
+        },
+      ];
+      const hook = () => hooks.usePublicProfile(id);
+      const { data } = await mockHook({
+        hook,
+        wrapper,
+        endpoints,
+      });
+      expect(queryClient.getQueryData(buildPublicProfileKey(id))).toEqual(
+        response,
+      );
+      expect(data).toMatchObject(response);
+    });
+  });
+});

src/hooks/publicProfile.ts

@@ -0,0 +1,34 @@
+import { UUID } from '@graasp/sdk';
+
+import { useQuery } from 'react-query';
+
+import * as Api from '../api';
+import { UndefinedArgument } from '../config/errors';
+import { OWN_PUBLIC_PROFILE_KEY, buildPublicProfileKey } from '../config/keys';
+import { QueryClientConfig } from '../types';
+
+export default (queryConfig: QueryClientConfig) => {
+  const { defaultQueryOptions } = queryConfig;
+
+  return {
+    useOwnProfile: () =>
+      useQuery({
+        queryKey: OWN_PUBLIC_PROFILE_KEY,
+        queryFn: () => Api.getOwnProfile(queryConfig),
+        ...defaultQueryOptions,
+      }),
+
+    usePublicProfile: (memberId: UUID) =>
+      useQuery({
+        queryKey: buildPublicProfileKey(memberId),
+        queryFn: () => {
+          if (!memberId) {
+            throw new UndefinedArgument();
+          }
+          return Api.getPublicProfile(memberId, queryConfig);
+        },
+        enabled: Boolean(memberId),
+        ...defaultQueryOptions,
+      }),
+  };
+};

src/mutations/index.ts

@@ -17,6 +17,7 @@ import memberMutations from './member';
 import itemMembershipMutations from './membership';
 import mentionMutations from './mention';
 import subscriptionMutations from './plan';
+import publicProfileMutations from './publicProfile';
 import shortLinksMutations from './shortLink';
 
 const configureMutations = (queryConfig: QueryClientConfig) => ({
@@ -38,6 +39,7 @@ const configureMutations = (queryConfig: QueryClientConfig) => ({
   ...authenticationMutations(queryConfig),
   ...subscriptionMutations(queryConfig),
   ...itemPublishMutations(queryConfig),
+  ...publicProfileMutations(queryConfig),
   ...shortLinksMutations(queryConfig),
 });
 

src/mutations/publicProfile.test.ts

@@ -0,0 +1,102 @@
+import { HttpMethod } from '@graasp/sdk';
+
+import { act } from '@testing-library/react';
+import nock from 'nock';
+
+import { MEMBER_RESPONSE } from '../../test/constants';
+import { mockMutation, setUpTest, waitForMutation } from '../../test/utils';
+import { MEMBERS_ROUTE, PUBLIC_PROFILE_ROUTE } from '../api/routes';
+import { OWN_PUBLIC_PROFILE_KEY } from '../config/keys';
+
+const mockedNotifier = jest.fn();
+const { wrapper, queryClient, mutations } = setUpTest({
+  notifier: mockedNotifier,
+});
+const newProfile = {
+  bio: 'text',
+  twitterID: 'twitter_handle',
+  facebookID: 'fb_handle',
+  linkedinID: 'linkedin_handle',
+  visibility: false,
+};
+describe('Public Profile Mutations', () => {
+  afterEach(() => {
+    queryClient.clear();
+    nock.cleanAll();
+    mockedNotifier.mockClear();
+  });
+
+  describe('usePostPublicProfile', () => {
+    const mutation = mutations.usePostPublicProfile;
+
+    it('Post profile', async () => {
+      const route = `/${MEMBERS_ROUTE}/${PUBLIC_PROFILE_ROUTE}`;
+      const response = { ...newProfile, id: 'someid', member: MEMBER_RESPONSE };
+
+      queryClient.setQueryData(OWN_PUBLIC_PROFILE_KEY, response);
+
+      const endpoints = [
+        {
+          response,
+          method: HttpMethod.POST,
+          route,
+        },
+      ];
+
+      const mockedMutation = await mockMutation({
+        endpoints,
+        mutation,
+        wrapper,
+      });
+
+      await act(async () => {
+        await mockedMutation.mutate(newProfile);
+        await waitForMutation();
+      });
+
+      expect(queryClient.getQueryState(OWN_PUBLIC_PROFILE_KEY)?.data).toEqual(
+        response,
+      );
+    });
+  });
+
+  describe('usePatchPublicProfile', () => {
+    const mutation = mutations.usePatchPublicProfile;
+    const payload = { bio: 'new description' };
+    const result = {
+      ...newProfile,
+      bio: 'new description',
+      id: 'someid',
+      member: MEMBER_RESPONSE,
+    };
+
+    it('Edit public profile', async () => {
+      const route = `/${MEMBERS_ROUTE}/${PUBLIC_PROFILE_ROUTE}`;
+      const response = null;
+      const endpoints = [
+        {
+          response,
+          method: HttpMethod.PATCH,
+          route,
+        },
+      ];
+      queryClient.setQueryData(OWN_PUBLIC_PROFILE_KEY, result);
+
+      const mockedMutation = await mockMutation({
+        endpoints,
+        mutation,
+        wrapper,
+      });
+
+      await act(async () => {
+        await mockedMutation.mutate(payload);
+        await waitForMutation();
+      });
+
+      expect(queryClient.getQueryState(OWN_PUBLIC_PROFILE_KEY)?.data).toEqual(
+        result,
+      );
+      expect(queryClient.getQueryData(OWN_PUBLIC_PROFILE_KEY)).toEqual(result);
+    });
+  });
+});