@comapeo/core-react 9.0.2 → 10.0.0

package/dist/esm/hooks/maps.js

@@ -1,11 +1,10 @@
-import { CUSTOM_MAP_ID } from '@comapeo/map-server/constants.js';
+import { CUSTOM_MAP_ID, DEFAULT_MAP_ID } from '@comapeo/map-server/constants.js';
 import { errors } from '@comapeo/map-server/errors.js';
 import { useMutation, useQuery, useQueryClient, useSuspenseQuery, } from '@tanstack/react-query';
 import { useCallback } from 'react';
 import { useMapServerApi } from '../contexts/MapServer.js';
 import { useReceivedMapSharesActions, useReceivedMapSharesState, useSentMapSharesActions, useSentMapSharesState, } from '../contexts/MapShares.js';
-import { mapImportMutationOptions, mapInfoQueryOptions, mapRemoveMutationOptions, mapSharesMutationOptions, mapStyleJsonUrlQueryOptions, } from '../lib/react-query/maps.js';
-import { filterMutationResult } from '../lib/react-query/mutation-result.js';
+import { baseMutationOptions, baseQueryOptions, filterMutationResult, getMapInfoQueryKey, getStyleJsonUrlQueryKey, invalidateMapQueries, } from '../lib/react-query.js';
 /**
  * Get a URL that points to a StyleJSON resource served by the embedded HTTP server.
  *
@@ -34,7 +33,22 @@ import { filterMutationResult } from '../lib/react-query/mutation-result.js';
  */
 export function useMapStyleUrl() {
     const mapServerApi = useMapServerApi();
-    const { data, error, isRefetching } = useSuspenseQuery(mapStyleJsonUrlQueryOptions({ mapServerApi }));
+    // TODO: Support custom maps
+    const mapId = DEFAULT_MAP_ID;
+    const { data, error, isRefetching } = useSuspenseQuery({
+        ...baseQueryOptions(),
+        queryKey: getStyleJsonUrlQueryKey({ mapId }),
+        queryFn: async () => {
+            const result = await mapServerApi.getMapStyleJsonUrl(mapId);
+            const u = new URL(result);
+            // This ensures that every time this query is refetched, it will have a different search param, forcing the map to reload.
+            u.searchParams.set('refresh_token', Date.now().toString());
+            return u.href;
+        },
+        // Keep this cached until the cache is manually invalidated by a map upload
+        staleTime: Infinity,
+        gcTime: Infinity,
+    });
     return { data, error, isRefetching };
 }
 /**
@@ -52,20 +66,54 @@ export function useMapStyleUrl() {
 export function useImportCustomMapFile() {
     const mapServerApi = useMapServerApi();
     const queryClient = useQueryClient();
-    const options = mapImportMutationOptions({ mapServerApi, queryClient });
-    const result = useMutation(options);
-    return filterMutationResult(result);
+    // TODO: Support importing to other custom map IDs, to support multiple maps.
+    const mapId = CUSTOM_MAP_ID;
+    return filterMutationResult(useMutation({
+        ...baseMutationOptions(),
+        mutationFn: async ({ file }) => {
+            if ('exists' in file && !file.exists) {
+                throw new Error('File does not exist or is not accessible');
+            }
+            return mapServerApi.put(`maps/${mapId}`, {
+                body: file,
+                headers: {
+                    'Content-Type': 'application/octet-stream',
+                },
+            });
+        },
+        onSuccess: async () => {
+            await invalidateMapQueries(queryClient, { mapId });
+        },
+    }));
 }
 export function useRemoveCustomMapFile() {
     const mapServerApi = useMapServerApi();
     const queryClient = useQueryClient();
-    const options = mapRemoveMutationOptions({ mapServerApi, queryClient });
-    const result = useMutation(options);
-    return filterMutationResult(result);
+    const mapId = CUSTOM_MAP_ID;
+    return filterMutationResult(useMutation({
+        ...baseMutationOptions(),
+        mutationFn: async () => {
+            return mapServerApi.delete(`maps/${mapId}`);
+        },
+        onSuccess: async () => {
+            await invalidateMapQueries(queryClient, { mapId });
+        },
+    }));
 }
 export function useGetCustomMapInfo() {
     const mapServerApi = useMapServerApi();
-    const { data, error, isRefetching } = useQuery(mapInfoQueryOptions({ mapServerApi, mapId: CUSTOM_MAP_ID }));
+    // TODO: Support custom maps
+    const mapId = CUSTOM_MAP_ID;
+    const { data, error, isRefetching } = useQuery({
+        ...baseQueryOptions(),
+        queryKey: getMapInfoQueryKey({ mapId }),
+        queryFn: async () => {
+            return mapServerApi.get(`maps/${mapId}/info`).json();
+        },
+        // Keep this cached until the cache is manually invalidated by a map upload
+        staleTime: Infinity,
+        gcTime: Infinity,
+    });
     return { data, error, isRefetching };
 }
 // ============================================
@@ -136,9 +184,12 @@ export function useSingleReceivedMapShare({ shareId }) {
  */
 export function useDownloadReceivedMapShare() {
     const { download } = useReceivedMapSharesActions();
-    const options = mapSharesMutationOptions({ action: download });
-    const result = useMutation(options);
-    return filterMutationResult(result);
+    return filterMutationResult(useMutation({
+        ...baseMutationOptions(),
+        mutationFn: async (options) => {
+            return download(options);
+        },
+    }));
 }
 /**
  * Decline a map share that has been received. Notifies the sender that the
@@ -164,9 +215,12 @@ export function useDownloadReceivedMapShare() {
  */
 export function useDeclineReceivedMapShare() {
     const { decline } = useReceivedMapSharesActions();
-    const options = mapSharesMutationOptions({ action: decline });
-    const result = useMutation(options);
-    return filterMutationResult(result);
+    return filterMutationResult(useMutation({
+        ...baseMutationOptions(),
+        mutationFn: async (options) => {
+            return decline(options);
+        },
+    }));
 }
 /**
  * Abort an in-progress map share download.
@@ -185,9 +239,12 @@ export function useDeclineReceivedMapShare() {
  */
 export function useAbortReceivedMapShareDownload() {
     const { abort } = useReceivedMapSharesActions();
-    const options = mapSharesMutationOptions({ action: abort });
-    const result = useMutation(options);
-    return filterMutationResult(result);
+    return filterMutationResult(useMutation({
+        ...baseMutationOptions(),
+        mutationFn: async (options) => {
+            return abort(options);
+        },
+    }));
 }
 // ============================================
 // SENDER HOOKS
@@ -203,25 +260,32 @@ export function useAbortReceivedMapShareDownload() {
  * @example
  * ```tsx
  * function SendMapButton({ projectId, deviceId }: { projectId: string; deviceId: string }) {
- *   const { mutate: send } = useSendMapShare({ projectId }, {
- *     onSuccess: (mapShare) => {
- *  	   console.log('Share sent with id', mapShare.shareId)
- *     }
- *   })
- *
- *   return (
- *     <button onClick={() => send({ receiverDeviceId: deviceId, mapId: 'custom' })}>
- *       Send Map
- *     </button>
- *   )
+ *	const { mutate: send } = useSendMapShare()
+ *
+ *	return (
+ *		<button
+ *			onClick={() =>
+ *				send({ projectId, receiverDeviceId: deviceId, mapId: 'custom' }, {
+ *                    onSuccess: (mapShare) => {
+ *                        console.log('Share sent with id', mapShare.shareId)
+ *                    }
+ *              )
+ *			}
+ *		>
+ *			Send Map
+ *		</button>
+ *	)
  * }
  * ```
  */
-export function useSendMapShare({ projectId }) {
+export function useSendMapShare() {
     const { createAndSend } = useSentMapSharesActions();
-    const options = mapSharesMutationOptions({ action: createAndSend, projectId });
-    const result = useMutation(options);
-    return filterMutationResult(result);
+    return filterMutationResult(useMutation({
+        ...baseMutationOptions(),
+        mutationFn: async (options) => {
+            return createAndSend(options);
+        },
+    }));
 }
 /**
  * Cancel a map share that was previously sent. If the recipient has not yet
@@ -243,9 +307,12 @@ export function useSendMapShare({ projectId }) {
  */
 export function useCancelSentMapShare() {
     const { cancel } = useSentMapSharesActions();
-    const options = mapSharesMutationOptions({ action: cancel });
-    const result = useMutation(options);
-    return filterMutationResult(result);
+    return filterMutationResult(useMutation({
+        ...baseMutationOptions(),
+        mutationFn: async (options) => {
+            return cancel(options);
+        },
+    }));
 }
 /**
  * Track the status and progress of a sent map share. Returns the current state