feat: add geolocation hooks and mutations (#590)

Author: pyphilia

package.json

@@ -17,10 +17,11 @@
     "Alexandre Chau"
   ],
   "dependencies": {
-    "@graasp/sdk": "3.5.0",
-    "@graasp/translations": "1.22.1",
+    "@graasp/sdk": "3.6.0",
+    "@graasp/translations": "github:graasp/graasp-translations#geolocation",
     "axios": "0.27.2",
     "crypto-js": "4.2.0",
+    "date-fns": "3.3.1",
     "http-status-codes": "2.3.0",
     "qs": "6.11.2",
     "react-query": "3.39.3",

src/api/index.ts

@@ -21,3 +21,4 @@ export * from './search';
 export * from './subscription';
 export * from './publicProfile';
 export * from './shortLink';
+export * from './itemGeolocation';

src/api/item.ts

@@ -1,5 +1,6 @@
 import {
   DiscriminatedItem,
+  ItemGeolocation,
   RecycledItemData,
   ResultOf,
   UUID,
@@ -77,11 +78,21 @@ export const getAccessibleItems = async (
 export type PostItemPayloadType = Partial<DiscriminatedItem> &
   Pick<DiscriminatedItem, 'type' | 'name'> & {
     parentId?: UUID;
+  } & {
+    geolocation?: Pick<ItemGeolocation, 'lat' | 'lng'>;
   };
-// payload = {name, type, description, extra}
+
+// payload = {name, type, description, extra, geolocation}
 // querystring = {parentId}
 export const postItem = async (
-  { name, type, description, extra, parentId }: PostItemPayloadType,
+  {
+    name,
+    type,
+    description,
+    extra,
+    parentId,
+    geolocation,
+  }: PostItemPayloadType,
   { API_HOST, axios }: PartialQueryConfigForApi,
 ) =>
   verifyAuthentication(() =>
@@ -91,6 +102,7 @@ export const postItem = async (
         type,
         description,
         extra,
+        geolocation,
       })
       .then(({ data }) => data),
   );

src/api/itemGeolocation.ts

@@ -0,0 +1,62 @@
+import { Item, ItemGeolocation, UUID } from '@graasp/sdk';
+
+import { PartialQueryConfigForApi } from '../types';
+import { verifyAuthentication } from './axios';
+import {
+  buildDeleteItemGeolocationRoute,
+  buildGetItemGeolocationRoute,
+  buildGetItemsInMapRoute,
+  buildPutItemGeolocationRoute,
+} from './routes';
+
+// eslint-disable-next-line import/prefer-default-export
+export const getItemGeolocation = async (
+  { API_HOST, axios }: PartialQueryConfigForApi,
+  id: UUID,
+) =>
+  axios
+    .get<ItemGeolocation>(`${API_HOST}/${buildGetItemGeolocationRoute(id)}`)
+    .then(({ data }) => data);
+
+export const putItemGeolocation = async (
+  payload: {
+    itemId: Item['id'];
+    geolocation: Pick<ItemGeolocation, 'lat' | 'lng'>;
+  },
+  { API_HOST, axios }: PartialQueryConfigForApi,
+) =>
+  verifyAuthentication(() =>
+    axios
+      .put<void>(
+        `${API_HOST}/${buildPutItemGeolocationRoute(payload.itemId)}`,
+        payload,
+      )
+      .then(({ data }) => data),
+  );
+
+export const getItemsInMap = async (
+  payload: {
+    lat1: ItemGeolocation['lat'];
+    lat2: ItemGeolocation['lat'];
+    lng1: ItemGeolocation['lng'];
+    lng2: ItemGeolocation['lng'];
+  },
+  { API_HOST, axios }: PartialQueryConfigForApi,
+) =>
+  verifyAuthentication(() =>
+    axios
+      .get<ItemGeolocation[]>(`${API_HOST}/${buildGetItemsInMapRoute(payload)}`)
+      .then(({ data }) => data),
+  );
+
+export const deleteItemGeolocation = async (
+  payload: { itemId: UUID },
+  { API_HOST, axios }: PartialQueryConfigForApi,
+) =>
+  verifyAuthentication(() =>
+    axios
+      .delete<void>(
+        `${API_HOST}/${buildDeleteItemGeolocationRoute(payload.itemId)}`,
+      )
+      .then(({ data }) => data),
+  );

src/api/routes.ts

@@ -441,6 +441,25 @@ export const buildPostShortLinkRoute = () => `${SHORT_LINKS_ROUTE}`;
 export const buildPatchShortLinkRoute = (alias: string) =>
   `${SHORT_LINKS_ROUTE}/${alias}`;
 
+export const buildGetItemGeolocationRoute = (itemId: UUID) =>
+  `${ITEMS_ROUTE}/${itemId}/geolocation`;
+export const buildPutItemGeolocationRoute = (itemId: UUID) =>
+  `${ITEMS_ROUTE}/${itemId}/geolocation`;
+export const buildDeleteItemGeolocationRoute = (itemId: UUID) =>
+  `${ITEMS_ROUTE}/${itemId}/geolocation`;
+export const buildGetItemsInMapRoute = ({
+  lat1,
+  lat2,
+  lng1,
+  lng2,
+}: {
+  lat1: number;
+  lat2: number;
+  lng1: number;
+  lng2: number;
+}) =>
+  `${ITEMS_ROUTE}/geolocation?lat1=${lat1}&lat2=${lat2}&lng1=${lng1}&lng2=${lng2}`;
+
 export const API_ROUTES = {
   APPS_ROUTE,
   buildAppListRoute,
@@ -553,4 +572,8 @@ export const API_ROUTES = {
   PUBLIC_PROFILE_ROUTE,
   GET_OWN_PROFILE,
   buildGetPublicProfileRoute,
+  buildGetItemsInMapRoute,
+  buildGetItemGeolocationRoute,
+  buildDeleteItemGeolocationRoute,
+  buildPutItemGeolocationRoute,
 };

src/config/errors.ts

@@ -11,9 +11,9 @@ export class UserIsSignedOut extends Error {
 }
 
 export class UndefinedArgument extends Error {
-  constructor() {
+  constructor(data?: object) {
     super();
-    this.message = 'UnexpectedInput';
+    this.message = `UnexpectedInput ${JSON.stringify(data ?? {})}`;
     this.name = 'UnexpectedInput';
     this.stack = new Error().stack;
   }

src/config/keys.ts

@@ -279,6 +279,28 @@ export const CURRENT_MEMBER_STORAGE_KEY = [
 
 export const OWN_PUBLIC_PROFILE_KEY = ['own-profile'];
 export const buildPublicProfileKey = (memberId: UUID) => ['profile', memberId];
+
+export const itemsWithGeolocationKeys = {
+  allBounds: [ITEMS_CONTEXT, 'map'],
+  inBounds: ({
+    lat1,
+    lat2,
+    lng1,
+    lng2,
+  }: {
+    lat1: number;
+    lat2: number;
+    lng1: number;
+    lng2: number;
+  }) => [...itemsWithGeolocationKeys.allBounds, { lat1, lat2, lng1, lng2 }],
+};
+
+export const buildItemGeolocationKey = (itemId?: UUID) => [
+  ITEMS_CONTEXT,
+  itemId,
+  'geolocation',
+];
+
 export const DATA_KEYS = {
   APPS_KEY,
   buildItemKey,
@@ -320,4 +342,6 @@ export const DATA_KEYS = {
   buildSearchPublishedItemsKey,
   OWN_PUBLIC_PROFILE_KEY,
   buildPublicProfileKey,
+  itemsWithGeolocationKeys,
+  buildItemGeolocationKey,
 };

src/hooks/index.ts

@@ -8,6 +8,7 @@ import configureChatHooks from './chat';
 import configureInvitationHooks from './invitation';
 import configureItemHooks from './item';
 import configureItemFavoriteHooks from './itemFavorite';
+import configureItemGeolocationHooks from './itemGeolocation';
 import configureItemLikeHooks from './itemLike';
 import configureItemLoginHooks from './itemLogin';
 import configureItemPublishedHooks from './itemPublish';
@@ -55,5 +56,6 @@ export default (
     ...configurePlanHooks(queryConfig),
     ...configurePublicProfileHooks(queryConfig),
     ...configureShortLinkHooks(queryConfig),
+    ...configureItemGeolocationHooks(queryConfig),
   };
 };