fix: preserve type narrowing of useGetCustomMapInfo() read hook

docs/API.md

@@ -1153,9 +1153,39 @@ function MapImportExample() {
 
 ### useGetCustomMapInfo
 
+Get the map info for the custom map.
+
+Note that this is _not_ a suspenseful hook. The different read states should be explicitly handled at usage.
+
 | Function | Type |
 | ---------- | ---------- |
-| `useGetCustomMapInfo` | `() => { data: any; error: Error or null; isRefetching: boolean; }` |
+| `useGetCustomMapInfo` | `() => Pick<QueryObserverRefetchErrorResult<MapInfoResponse, Error>, "data" or "error" or "status" or "isRefetching"> or Pick<QueryObserverSuccessResult<MapInfoResponse, Error>, "data" or ... 2 more ... or "isRefetching"> or Pick<...> or Pick<...> or Pick<...> or Pick<...>` |
+
+Examples:
+
+```tsx
+import { getErrorCode } from '@comapeo/core-react'
+
+function Example() {
+  const mapInfo = useGetCustomMapInfo()
+
+  if (mapInfo.status === 'pending') {
+    // handle pending...
+  }
+
+  if (mapInfo.status === 'error') {
+    if (getErrorCode(mapInfo.error) === 'MAP_NOT_FOUND') {
+      // handle not found error...
+    } else {
+      // handle all other errors...
+    }
+  }
+
+  // Handle success state...
+  console.log(mapInfo.data)
+}
+```
+
 
 ### useManyReceivedMapShares
 

src/hooks/maps.ts

@@ -29,6 +29,7 @@ import {
 	baseMutationOptions,
 	baseQueryOptions,
 	filterMutationResult,
+	filterQueryResult,
 	getMapInfoQueryKey,
 	getStyleJsonUrlQueryKey,
 	invalidateMapQueries,
@@ -138,13 +139,43 @@ export function useRemoveCustomMapFile() {
 	)
 }
 
+/**
+ * Get the map info for the custom map.
+ *
+ * Note that this is _not_ a suspenseful hook. The different read states should be explicitly handled at usage.
+ *
+ * @example
+ * ```tsx
+ * import { getErrorCode } from '@comapeo/core-react'
+ *
+ * function Example() {
+ *   const mapInfo = useGetCustomMapInfo()
+ *
+ *   if (mapInfo.status === 'pending') {
+ *     // handle pending...
+ *   }
+ *
+ *   if (mapInfo.status === 'error') {
+ *     if (getErrorCode(mapInfo.error) === 'MAP_NOT_FOUND') {
+ *       // handle not found error...
+ *     } else {
+ *       // handle all other errors...
+ *     }
+ *   }
+ *
+ *   // Handle success state...
+ *   console.log(mapInfo.data)
+ * }
+ * ```
+ *
+ */
 export function useGetCustomMapInfo() {
 	const mapServerApi = useMapServerApi()
 
 	// TODO: Support custom maps
 	const mapId = CUSTOM_MAP_ID
 
-	const { data, error, isRefetching } = useQuery({
+	const result = useQuery({
 		...baseQueryOptions(),
 		queryKey: getMapInfoQueryKey({ mapId }),
 		queryFn: async () => {
@@ -155,7 +186,7 @@ export function useGetCustomMapInfo() {
 		gcTime: Infinity,
 	})
 
-	return { data, error, isRefetching }
+	return filterQueryResult(result)
 }
 
 // ============================================

src/lib/react-query.ts

@@ -4,6 +4,7 @@ import type {
 	QueryOptions,
 	UseMutationOptions,
 	UseMutationResult,
+	UseQueryResult,
 } from '@tanstack/react-query'
 import { DistributedPick } from 'type-fest'
 
@@ -61,6 +62,29 @@ export function filterMutationResult<
 	return filteredResult
 }
 
+const PICKED_QUERY_RESULT_KEYS = [
+	'data',
+	'error',
+	'isRefetching',
+	'status',
+] as const satisfies ReadonlyArray<keyof UseQueryResult>
+
+export type FilteredQueryResult<
+	// eslint-disable-next-line @typescript-eslint/no-explicit-any
+	TResult extends UseQueryResult<any, any>,
+> = DistributedPick<TResult, (typeof PICKED_QUERY_RESULT_KEYS)[number]>
+
+export function filterQueryResult<
+	// eslint-disable-next-line @typescript-eslint/no-explicit-any
+	TResult extends UseQueryResult<any, any>,
+>(queryResult: TResult) {
+	const filteredResult = {} as FilteredQueryResult<TResult>
+	for (const key of PICKED_QUERY_RESULT_KEYS) {
+		filteredResult[key] = queryResult[key]
+	}
+	return filteredResult
+}
+
 // #endregion
 
 // #region Client