@comapeo/core-react 9.0.1 → 10.0.0

package/dist/commonjs/hooks/maps.js

@@ -18,8 +18,7 @@ const react_query_1 = require("@tanstack/react-query");
 const react_1 = require("react");
 const MapServer_js_1 = require("../contexts/MapServer.js");
 const MapShares_js_1 = require("../contexts/MapShares.js");
-const maps_js_1 = require("../lib/react-query/maps.js");
-const mutation_result_js_1 = require("../lib/react-query/mutation-result.js");
+const react_query_js_1 = require("../lib/react-query.js");
 /**
  * Get a URL that points to a StyleJSON resource served by the embedded HTTP server.
  *
@@ -48,7 +47,22 @@ const mutation_result_js_1 = require("../lib/react-query/mutation-result.js");
  */
 function useMapStyleUrl() {
     const mapServerApi = (0, MapServer_js_1.useMapServerApi)();
-    const { data, error, isRefetching } = (0, react_query_1.useSuspenseQuery)((0, maps_js_1.mapStyleJsonUrlQueryOptions)({ mapServerApi }));
+    // TODO: Support custom maps
+    const mapId = constants_js_1.DEFAULT_MAP_ID;
+    const { data, error, isRefetching } = (0, react_query_1.useSuspenseQuery)({
+        ...(0, react_query_js_1.baseQueryOptions)(),
+        queryKey: (0, react_query_js_1.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 };
 }
 /**
@@ -66,20 +80,54 @@ function useMapStyleUrl() {
 function useImportCustomMapFile() {
     const mapServerApi = (0, MapServer_js_1.useMapServerApi)();
     const queryClient = (0, react_query_1.useQueryClient)();
-    const options = (0, maps_js_1.mapImportMutationOptions)({ mapServerApi, queryClient });
-    const result = (0, react_query_1.useMutation)(options);
-    return (0, mutation_result_js_1.filterMutationResult)(result);
+    // TODO: Support importing to other custom map IDs, to support multiple maps.
+    const mapId = constants_js_1.CUSTOM_MAP_ID;
+    return (0, react_query_js_1.filterMutationResult)((0, react_query_1.useMutation)({
+        ...(0, react_query_js_1.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 (0, react_query_js_1.invalidateMapQueries)(queryClient, { mapId });
+        },
+    }));
 }
 function useRemoveCustomMapFile() {
     const mapServerApi = (0, MapServer_js_1.useMapServerApi)();
     const queryClient = (0, react_query_1.useQueryClient)();
-    const options = (0, maps_js_1.mapRemoveMutationOptions)({ mapServerApi, queryClient });
-    const result = (0, react_query_1.useMutation)(options);
-    return (0, mutation_result_js_1.filterMutationResult)(result);
+    const mapId = constants_js_1.CUSTOM_MAP_ID;
+    return (0, react_query_js_1.filterMutationResult)((0, react_query_1.useMutation)({
+        ...(0, react_query_js_1.baseMutationOptions)(),
+        mutationFn: async () => {
+            return mapServerApi.delete(`maps/${mapId}`);
+        },
+        onSuccess: async () => {
+            await (0, react_query_js_1.invalidateMapQueries)(queryClient, { mapId });
+        },
+    }));
 }
 function useGetCustomMapInfo() {
     const mapServerApi = (0, MapServer_js_1.useMapServerApi)();
-    const { data, error, isRefetching } = (0, react_query_1.useQuery)((0, maps_js_1.mapInfoQueryOptions)({ mapServerApi, mapId: constants_js_1.CUSTOM_MAP_ID }));
+    // TODO: Support custom maps
+    const mapId = constants_js_1.CUSTOM_MAP_ID;
+    const { data, error, isRefetching } = (0, react_query_1.useQuery)({
+        ...(0, react_query_js_1.baseQueryOptions)(),
+        queryKey: (0, react_query_js_1.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 };
 }
 // ============================================
@@ -150,9 +198,12 @@ function useSingleReceivedMapShare({ shareId }) {
  */
 function useDownloadReceivedMapShare() {
     const { download } = (0, MapShares_js_1.useReceivedMapSharesActions)();
-    const options = (0, maps_js_1.mapSharesMutationOptions)({ action: download });
-    const result = (0, react_query_1.useMutation)(options);
-    return (0, mutation_result_js_1.filterMutationResult)(result);
+    return (0, react_query_js_1.filterMutationResult)((0, react_query_1.useMutation)({
+        ...(0, react_query_js_1.baseMutationOptions)(),
+        mutationFn: async (options) => {
+            return download(options);
+        },
+    }));
 }
 /**
  * Decline a map share that has been received. Notifies the sender that the
@@ -178,9 +229,12 @@ function useDownloadReceivedMapShare() {
  */
 function useDeclineReceivedMapShare() {
     const { decline } = (0, MapShares_js_1.useReceivedMapSharesActions)();
-    const options = (0, maps_js_1.mapSharesMutationOptions)({ action: decline });
-    const result = (0, react_query_1.useMutation)(options);
-    return (0, mutation_result_js_1.filterMutationResult)(result);
+    return (0, react_query_js_1.filterMutationResult)((0, react_query_1.useMutation)({
+        ...(0, react_query_js_1.baseMutationOptions)(),
+        mutationFn: async (options) => {
+            return decline(options);
+        },
+    }));
 }
 /**
  * Abort an in-progress map share download.
@@ -199,9 +253,12 @@ function useDeclineReceivedMapShare() {
  */
 function useAbortReceivedMapShareDownload() {
     const { abort } = (0, MapShares_js_1.useReceivedMapSharesActions)();
-    const options = (0, maps_js_1.mapSharesMutationOptions)({ action: abort });
-    const result = (0, react_query_1.useMutation)(options);
-    return (0, mutation_result_js_1.filterMutationResult)(result);
+    return (0, react_query_js_1.filterMutationResult)((0, react_query_1.useMutation)({
+        ...(0, react_query_js_1.baseMutationOptions)(),
+        mutationFn: async (options) => {
+            return abort(options);
+        },
+    }));
 }
 // ============================================
 // SENDER HOOKS
@@ -217,25 +274,32 @@ 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>
+ *	)
  * }
  * ```
  */
-function useSendMapShare({ projectId }) {
+function useSendMapShare() {
     const { createAndSend } = (0, MapShares_js_1.useSentMapSharesActions)();
-    const options = (0, maps_js_1.mapSharesMutationOptions)({ action: createAndSend, projectId });
-    const result = (0, react_query_1.useMutation)(options);
-    return (0, mutation_result_js_1.filterMutationResult)(result);
+    return (0, react_query_js_1.filterMutationResult)((0, react_query_1.useMutation)({
+        ...(0, react_query_js_1.baseMutationOptions)(),
+        mutationFn: async (options) => {
+            return createAndSend(options);
+        },
+    }));
 }
 /**
  * Cancel a map share that was previously sent. If the recipient has not yet
@@ -257,9 +321,12 @@ function useSendMapShare({ projectId }) {
  */
 function useCancelSentMapShare() {
     const { cancel } = (0, MapShares_js_1.useSentMapSharesActions)();
-    const options = (0, maps_js_1.mapSharesMutationOptions)({ action: cancel });
-    const result = (0, react_query_1.useMutation)(options);
-    return (0, mutation_result_js_1.filterMutationResult)(result);
+    return (0, react_query_js_1.filterMutationResult)((0, react_query_1.useMutation)({
+        ...(0, react_query_js_1.baseMutationOptions)(),
+        mutationFn: async (options) => {
+            return cancel(options);
+        },
+    }));
 }
 /**
  * Track the status and progress of a sent map share. Returns the current state