@comapeo/core-react 7.2.0 → 9.0.0

package/dist/esm/hooks/maps.d.ts

@@ -1,3 +1,4 @@
+import { type ReceivedMapShareState, type SentMapShareState } from '../lib/map-shares-stores.js';
 /**
  * Get a URL that points to a StyleJSON resource served by the embedded HTTP server.
  *
@@ -24,10 +25,466 @@
  * }
  * ```
  */
-export declare function useMapStyleUrl({ refreshToken, }?: {
-    refreshToken?: string;
-}): {
+export declare function useMapStyleUrl(): {
     data: string;
     error: Error | null;
     isRefetching: boolean;
 };
+/**
+ * Import a custom SMP map file, replacing any existing custom map. The mutation
+ * resolves once the file is successfully uploaded and processed by the server.
+ *
+ * @example
+ * ```tsx
+ * function MapImportExample() {
+ *   const { mutate: importMap } = useImportCustomMapFile()
+ *
+ * }
+ * ```
+ */
+export declare function useImportCustomMapFile(): Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverIdleResult<Response, Error, {
+    file: File | ({
+        readonly name: string;
+        slice: (start?: number, end?: number, contentType?: string) => Blob;
+        readonly type: string;
+        text: () => Promise<string>;
+        readonly size: number;
+        arrayBuffer: () => Promise<ArrayBuffer>;
+        bytes: () => Promise<Uint8Array<ArrayBuffer>>;
+        stream: () => ReadableStream<Uint8Array<ArrayBuffer>>;
+    } & {
+        exists: boolean;
+    });
+}, unknown>, {
+    mutate: import("@tanstack/react-query").UseMutateFunction<Response, Error, {
+        file: File | ({
+            readonly name: string;
+            slice: (start?: number, end?: number, contentType?: string) => Blob;
+            readonly type: string;
+            text: () => Promise<string>;
+            readonly size: number;
+            arrayBuffer: () => Promise<ArrayBuffer>;
+            bytes: () => Promise<Uint8Array<ArrayBuffer>>;
+            stream: () => ReadableStream<Uint8Array<ArrayBuffer>>;
+        } & {
+            exists: boolean;
+        });
+    }, unknown>;
+}> & {
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<Response, Error, {
+        file: File | ({
+            readonly name: string;
+            slice: (start?: number, end?: number, contentType?: string) => Blob;
+            readonly type: string;
+            text: () => Promise<string>;
+            readonly size: number;
+            arrayBuffer: () => Promise<ArrayBuffer>;
+            bytes: () => Promise<Uint8Array<ArrayBuffer>>;
+            stream: () => ReadableStream<Uint8Array<ArrayBuffer>>;
+        } & {
+            exists: boolean;
+        });
+    }, unknown>;
+}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverLoadingResult<Response, Error, {
+    file: File | ({
+        readonly name: string;
+        slice: (start?: number, end?: number, contentType?: string) => Blob;
+        readonly type: string;
+        text: () => Promise<string>;
+        readonly size: number;
+        arrayBuffer: () => Promise<ArrayBuffer>;
+        bytes: () => Promise<Uint8Array<ArrayBuffer>>;
+        stream: () => ReadableStream<Uint8Array<ArrayBuffer>>;
+    } & {
+        exists: boolean;
+    });
+}, unknown>, {
+    mutate: import("@tanstack/react-query").UseMutateFunction<Response, Error, {
+        file: File | ({
+            readonly name: string;
+            slice: (start?: number, end?: number, contentType?: string) => Blob;
+            readonly type: string;
+            text: () => Promise<string>;
+            readonly size: number;
+            arrayBuffer: () => Promise<ArrayBuffer>;
+            bytes: () => Promise<Uint8Array<ArrayBuffer>>;
+            stream: () => ReadableStream<Uint8Array<ArrayBuffer>>;
+        } & {
+            exists: boolean;
+        });
+    }, unknown>;
+}> & {
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<Response, Error, {
+        file: File | ({
+            readonly name: string;
+            slice: (start?: number, end?: number, contentType?: string) => Blob;
+            readonly type: string;
+            text: () => Promise<string>;
+            readonly size: number;
+            arrayBuffer: () => Promise<ArrayBuffer>;
+            bytes: () => Promise<Uint8Array<ArrayBuffer>>;
+            stream: () => ReadableStream<Uint8Array<ArrayBuffer>>;
+        } & {
+            exists: boolean;
+        });
+    }, unknown>;
+}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverErrorResult<Response, Error, {
+    file: File | ({
+        readonly name: string;
+        slice: (start?: number, end?: number, contentType?: string) => Blob;
+        readonly type: string;
+        text: () => Promise<string>;
+        readonly size: number;
+        arrayBuffer: () => Promise<ArrayBuffer>;
+        bytes: () => Promise<Uint8Array<ArrayBuffer>>;
+        stream: () => ReadableStream<Uint8Array<ArrayBuffer>>;
+    } & {
+        exists: boolean;
+    });
+}, unknown>, {
+    mutate: import("@tanstack/react-query").UseMutateFunction<Response, Error, {
+        file: File | ({
+            readonly name: string;
+            slice: (start?: number, end?: number, contentType?: string) => Blob;
+            readonly type: string;
+            text: () => Promise<string>;
+            readonly size: number;
+            arrayBuffer: () => Promise<ArrayBuffer>;
+            bytes: () => Promise<Uint8Array<ArrayBuffer>>;
+            stream: () => ReadableStream<Uint8Array<ArrayBuffer>>;
+        } & {
+            exists: boolean;
+        });
+    }, unknown>;
+}> & {
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<Response, Error, {
+        file: File | ({
+            readonly name: string;
+            slice: (start?: number, end?: number, contentType?: string) => Blob;
+            readonly type: string;
+            text: () => Promise<string>;
+            readonly size: number;
+            arrayBuffer: () => Promise<ArrayBuffer>;
+            bytes: () => Promise<Uint8Array<ArrayBuffer>>;
+            stream: () => ReadableStream<Uint8Array<ArrayBuffer>>;
+        } & {
+            exists: boolean;
+        });
+    }, unknown>;
+}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverSuccessResult<Response, Error, {
+    file: File | ({
+        readonly name: string;
+        slice: (start?: number, end?: number, contentType?: string) => Blob;
+        readonly type: string;
+        text: () => Promise<string>;
+        readonly size: number;
+        arrayBuffer: () => Promise<ArrayBuffer>;
+        bytes: () => Promise<Uint8Array<ArrayBuffer>>;
+        stream: () => ReadableStream<Uint8Array<ArrayBuffer>>;
+    } & {
+        exists: boolean;
+    });
+}, unknown>, {
+    mutate: import("@tanstack/react-query").UseMutateFunction<Response, Error, {
+        file: File | ({
+            readonly name: string;
+            slice: (start?: number, end?: number, contentType?: string) => Blob;
+            readonly type: string;
+            text: () => Promise<string>;
+            readonly size: number;
+            arrayBuffer: () => Promise<ArrayBuffer>;
+            bytes: () => Promise<Uint8Array<ArrayBuffer>>;
+            stream: () => ReadableStream<Uint8Array<ArrayBuffer>>;
+        } & {
+            exists: boolean;
+        });
+    }, unknown>;
+}> & {
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<Response, Error, {
+        file: File | ({
+            readonly name: string;
+            slice: (start?: number, end?: number, contentType?: string) => Blob;
+            readonly type: string;
+            text: () => Promise<string>;
+            readonly size: number;
+            arrayBuffer: () => Promise<ArrayBuffer>;
+            bytes: () => Promise<Uint8Array<ArrayBuffer>>;
+            stream: () => ReadableStream<Uint8Array<ArrayBuffer>>;
+        } & {
+            exists: boolean;
+        });
+    }, unknown>;
+}, "error" | "status" | "mutate" | "reset" | "mutateAsync">;
+export declare function useRemoveCustomMapFile(): Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverIdleResult<Response, Error, void, unknown>, {
+    mutate: import("@tanstack/react-query").UseMutateFunction<Response, Error, void, unknown>;
+}> & {
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<Response, Error, void, unknown>;
+}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverLoadingResult<Response, Error, void, unknown>, {
+    mutate: import("@tanstack/react-query").UseMutateFunction<Response, Error, void, unknown>;
+}> & {
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<Response, Error, void, unknown>;
+}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverErrorResult<Response, Error, void, unknown>, {
+    mutate: import("@tanstack/react-query").UseMutateFunction<Response, Error, void, unknown>;
+}> & {
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<Response, Error, void, unknown>;
+}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverSuccessResult<Response, Error, void, unknown>, {
+    mutate: import("@tanstack/react-query").UseMutateFunction<Response, Error, void, unknown>;
+}> & {
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<Response, Error, void, unknown>;
+}, "error" | "status" | "mutate" | "reset" | "mutateAsync">;
+export declare function useGetCustomMapInfo(): {
+    data: unknown;
+    error: Error | null;
+    isRefetching: boolean;
+};
+/**
+ * Get all map shares that the device has received. Automatically updates when
+ * new shares arrive or share states change.
+ *
+ * IMPORTANT: This hook will not trigger a re-render when download progress
+ * updates, only when the status changes. This is to avoid excessive re-renders
+ * during downloads. Use `useSingleReceivedMapShare` to get real-time updates on
+ * a specific share, including download progress.
+ *
+ * @example
+ * ```tsx
+ * function MapSharesList() {
+ *   const shares = useManyReceivedMapShares()
+ *
+ *   return shares.map(share => (
+ *     <div key={share.shareId}>
+ *       {share.mapName} from {share.senderDeviceName} - {share.state}
+ *     </div>
+ *   ))
+ * }
+ * ```
+ */
+export declare function useManyReceivedMapShares(): ReceivedMapShareState[];
+/**
+ * Get a single received map share based on its shareId.
+ *
+ * @param opts.shareId ID of the map share
+ *
+ * @example
+ * ```tsx
+ * function MapShareDetail({ shareId }: { shareId: string }) {
+ *   const share = useSingleReceivedMapShare({ shareId })
+ *
+ *   return <div>{share.mapName} - {share.state}</div>
+ * }
+ * ```
+ */
+export declare function useSingleReceivedMapShare({ shareId }: {
+    shareId: string;
+}): ReceivedMapShareState;
+/**
+ * Accept and download a map share that has been received. The mutate promise
+ * resolves once the map _starts_ downloading, before it finishes downloading.
+ * Use `useManyMapShares` or `useSingleMapShare` to track download progress.
+ *
+ * Throws if the share is not in `status="pending"` or if the download fails to
+ * start (e.g. if the shareId if invalid).
+ *
+ * @example
+ * ```tsx
+ * function AcceptButton({ shareId }: { shareId: string }) {
+ *   const { mutate: accept } = useAcceptMapShare()
+ *
+ *   return <button onClick={() => accept({ shareId })}>Accept</button>
+ * }
+ * ```
+ */
+export declare function useDownloadReceivedMapShare(): Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverIdleResult<Promise<void>, Error, Omit<import("../lib/map-shares-stores.js").DownloadMapShareOptions, "projectId">, unknown>, {
+    mutate: import("@tanstack/react-query").UseMutateFunction<Promise<void>, Error, Omit<import("../lib/map-shares-stores.js").DownloadMapShareOptions, "projectId">, unknown>;
+}> & {
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<Promise<void>, Error, Omit<import("../lib/map-shares-stores.js").DownloadMapShareOptions, "projectId">, unknown>;
+}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverLoadingResult<Promise<void>, Error, Omit<import("../lib/map-shares-stores.js").DownloadMapShareOptions, "projectId">, unknown>, {
+    mutate: import("@tanstack/react-query").UseMutateFunction<Promise<void>, Error, Omit<import("../lib/map-shares-stores.js").DownloadMapShareOptions, "projectId">, unknown>;
+}> & {
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<Promise<void>, Error, Omit<import("../lib/map-shares-stores.js").DownloadMapShareOptions, "projectId">, unknown>;
+}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverErrorResult<Promise<void>, Error, Omit<import("../lib/map-shares-stores.js").DownloadMapShareOptions, "projectId">, unknown>, {
+    mutate: import("@tanstack/react-query").UseMutateFunction<Promise<void>, Error, Omit<import("../lib/map-shares-stores.js").DownloadMapShareOptions, "projectId">, unknown>;
+}> & {
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<Promise<void>, Error, Omit<import("../lib/map-shares-stores.js").DownloadMapShareOptions, "projectId">, unknown>;
+}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverSuccessResult<Promise<void>, Error, Omit<import("../lib/map-shares-stores.js").DownloadMapShareOptions, "projectId">, unknown>, {
+    mutate: import("@tanstack/react-query").UseMutateFunction<Promise<void>, Error, Omit<import("../lib/map-shares-stores.js").DownloadMapShareOptions, "projectId">, unknown>;
+}> & {
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<Promise<void>, Error, Omit<import("../lib/map-shares-stores.js").DownloadMapShareOptions, "projectId">, unknown>;
+}, "error" | "status" | "mutate" | "reset" | "mutateAsync">;
+/**
+ * Decline a map share that has been received. Notifies the sender that the
+ * share was declined.
+ *
+ * Throws if the share is not with `status="pending"`
+ * Throws if shareId is invalid
+ * Throws if decline request fails (e.g. network error)
+ *
+ * @example
+ * ```tsx
+ * import { DeclineReason } from '@comapeo/core-react'
+ * function DeclineButton({ shareId }: { shareId: string }) {
+ *   const { mutate: decline } = useDeclineMapShare()
+ *
+ *   return (
+ *     <button onClick={() => decline({ shareId, reason: DeclineReason.user_rejected })}>
+ *       Decline
+ *     </button>
+ *   )
+ * }
+ * ```
+ */
+export declare function useDeclineReceivedMapShare(): Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverIdleResult<Promise<void>, Error, Omit<import("../lib/map-shares-stores.js").DeclineMapShareOptions, "projectId">, unknown>, {
+    mutate: import("@tanstack/react-query").UseMutateFunction<Promise<void>, Error, Omit<import("../lib/map-shares-stores.js").DeclineMapShareOptions, "projectId">, unknown>;
+}> & {
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<Promise<void>, Error, Omit<import("../lib/map-shares-stores.js").DeclineMapShareOptions, "projectId">, unknown>;
+}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverLoadingResult<Promise<void>, Error, Omit<import("../lib/map-shares-stores.js").DeclineMapShareOptions, "projectId">, unknown>, {
+    mutate: import("@tanstack/react-query").UseMutateFunction<Promise<void>, Error, Omit<import("../lib/map-shares-stores.js").DeclineMapShareOptions, "projectId">, unknown>;
+}> & {
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<Promise<void>, Error, Omit<import("../lib/map-shares-stores.js").DeclineMapShareOptions, "projectId">, unknown>;
+}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverErrorResult<Promise<void>, Error, Omit<import("../lib/map-shares-stores.js").DeclineMapShareOptions, "projectId">, unknown>, {
+    mutate: import("@tanstack/react-query").UseMutateFunction<Promise<void>, Error, Omit<import("../lib/map-shares-stores.js").DeclineMapShareOptions, "projectId">, unknown>;
+}> & {
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<Promise<void>, Error, Omit<import("../lib/map-shares-stores.js").DeclineMapShareOptions, "projectId">, unknown>;
+}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverSuccessResult<Promise<void>, Error, Omit<import("../lib/map-shares-stores.js").DeclineMapShareOptions, "projectId">, unknown>, {
+    mutate: import("@tanstack/react-query").UseMutateFunction<Promise<void>, Error, Omit<import("../lib/map-shares-stores.js").DeclineMapShareOptions, "projectId">, unknown>;
+}> & {
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<Promise<void>, Error, Omit<import("../lib/map-shares-stores.js").DeclineMapShareOptions, "projectId">, unknown>;
+}, "error" | "status" | "mutate" | "reset" | "mutateAsync">;
+/**
+ * Abort an in-progress map share download.
+ *
+ * Throws if the share is not in `status="downloading"`
+ * Throws if shareId is invalid
+ *
+ * @example
+ * ```tsx
+ * function AbortButton({ shareId }: { shareId: string }) {
+ *   const { mutate: abort } = useAbortMapShareDownload()
+ *
+ *   return <button onClick={() => abort({ shareId })}>Cancel Download</button>
+ * }
+ * ```
+ */
+export declare function useAbortReceivedMapShareDownload(): Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverIdleResult<Promise<void>, Error, Omit<import("../lib/map-shares-stores.js").AbortMapShareOptions, "projectId">, unknown>, {
+    mutate: import("@tanstack/react-query").UseMutateFunction<Promise<void>, Error, Omit<import("../lib/map-shares-stores.js").AbortMapShareOptions, "projectId">, unknown>;
+}> & {
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<Promise<void>, Error, Omit<import("../lib/map-shares-stores.js").AbortMapShareOptions, "projectId">, unknown>;
+}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverLoadingResult<Promise<void>, Error, Omit<import("../lib/map-shares-stores.js").AbortMapShareOptions, "projectId">, unknown>, {
+    mutate: import("@tanstack/react-query").UseMutateFunction<Promise<void>, Error, Omit<import("../lib/map-shares-stores.js").AbortMapShareOptions, "projectId">, unknown>;
+}> & {
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<Promise<void>, Error, Omit<import("../lib/map-shares-stores.js").AbortMapShareOptions, "projectId">, unknown>;
+}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverErrorResult<Promise<void>, Error, Omit<import("../lib/map-shares-stores.js").AbortMapShareOptions, "projectId">, unknown>, {
+    mutate: import("@tanstack/react-query").UseMutateFunction<Promise<void>, Error, Omit<import("../lib/map-shares-stores.js").AbortMapShareOptions, "projectId">, unknown>;
+}> & {
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<Promise<void>, Error, Omit<import("../lib/map-shares-stores.js").AbortMapShareOptions, "projectId">, unknown>;
+}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverSuccessResult<Promise<void>, Error, Omit<import("../lib/map-shares-stores.js").AbortMapShareOptions, "projectId">, unknown>, {
+    mutate: import("@tanstack/react-query").UseMutateFunction<Promise<void>, Error, Omit<import("../lib/map-shares-stores.js").AbortMapShareOptions, "projectId">, unknown>;
+}> & {
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<Promise<void>, Error, Omit<import("../lib/map-shares-stores.js").AbortMapShareOptions, "projectId">, unknown>;
+}, "error" | "status" | "mutate" | "reset" | "mutateAsync">;
+/**
+ * Share a map with a device. The mutation resolves immediately after sending
+ * the share offer, without waiting for the recipient to accept or reject. The
+ * mutation resolves with the created map share object, including its ID, which
+ * can be used to track the share status with `useSingleSentMapShare`.
+ *
+ * @param opts.projectId Public ID of project for sending the map share: you can only send map shares to users on the same project
+ *
+ * @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>
+ *   )
+ * }
+ * ```
+ */
+export declare function useSendMapShare({ projectId }: {
+    projectId: string;
+}): Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverIdleResult<Promise<import("@comapeo/map-server").MapShareState>, Error, import("../lib/map-shares-stores.js").CreateAndSendMapShareOptions, unknown>, {
+    mutate: import("@tanstack/react-query").UseMutateFunction<Promise<import("@comapeo/map-server").MapShareState>, Error, import("../lib/map-shares-stores.js").CreateAndSendMapShareOptions, unknown>;
+}> & {
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<Promise<import("@comapeo/map-server").MapShareState>, Error, import("../lib/map-shares-stores.js").CreateAndSendMapShareOptions, unknown>;
+}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverLoadingResult<Promise<import("@comapeo/map-server").MapShareState>, Error, import("../lib/map-shares-stores.js").CreateAndSendMapShareOptions, unknown>, {
+    mutate: import("@tanstack/react-query").UseMutateFunction<Promise<import("@comapeo/map-server").MapShareState>, Error, import("../lib/map-shares-stores.js").CreateAndSendMapShareOptions, unknown>;
+}> & {
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<Promise<import("@comapeo/map-server").MapShareState>, Error, import("../lib/map-shares-stores.js").CreateAndSendMapShareOptions, unknown>;
+}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverErrorResult<Promise<import("@comapeo/map-server").MapShareState>, Error, import("../lib/map-shares-stores.js").CreateAndSendMapShareOptions, unknown>, {
+    mutate: import("@tanstack/react-query").UseMutateFunction<Promise<import("@comapeo/map-server").MapShareState>, Error, import("../lib/map-shares-stores.js").CreateAndSendMapShareOptions, unknown>;
+}> & {
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<Promise<import("@comapeo/map-server").MapShareState>, Error, import("../lib/map-shares-stores.js").CreateAndSendMapShareOptions, unknown>;
+}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverSuccessResult<Promise<import("@comapeo/map-server").MapShareState>, Error, import("../lib/map-shares-stores.js").CreateAndSendMapShareOptions, unknown>, {
+    mutate: import("@tanstack/react-query").UseMutateFunction<Promise<import("@comapeo/map-server").MapShareState>, Error, import("../lib/map-shares-stores.js").CreateAndSendMapShareOptions, unknown>;
+}> & {
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<Promise<import("@comapeo/map-server").MapShareState>, Error, import("../lib/map-shares-stores.js").CreateAndSendMapShareOptions, unknown>;
+}, "error" | "status" | "mutate" | "reset" | "mutateAsync">;
+/**
+ * Cancel a map share that was previously sent. If the recipient has not yet
+ * started downloading the share, they will not be notified until they attempt
+ * to accept the share and begin downloading it. If they are already downloading
+ * the share, the download will be canceled before completion. If the download
+ * is already complete, this action will throw an error.
+ *
+ * @param opts.projectId Public ID of project to request the map share cancellation for.
+ *
+ * @example
+ * ```tsx
+ * function CancelShareButton({ projectId, shareId }: { projectId: string; shareId: string }) {
+ *   const { mutate: cancel } = useRequestCancelMapShare({ projectId })
+ *
+ *   return <button onClick={() => cancel({ shareId })}>Cancel Share</button>
+ * }
+ * ```
+ */
+export declare function useCancelSentMapShare(): Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverIdleResult<Promise<void>, Error, Omit<import("../lib/map-shares-stores.js").CancelMapShareOptions, "projectId">, unknown>, {
+    mutate: import("@tanstack/react-query").UseMutateFunction<Promise<void>, Error, Omit<import("../lib/map-shares-stores.js").CancelMapShareOptions, "projectId">, unknown>;
+}> & {
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<Promise<void>, Error, Omit<import("../lib/map-shares-stores.js").CancelMapShareOptions, "projectId">, unknown>;
+}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverLoadingResult<Promise<void>, Error, Omit<import("../lib/map-shares-stores.js").CancelMapShareOptions, "projectId">, unknown>, {
+    mutate: import("@tanstack/react-query").UseMutateFunction<Promise<void>, Error, Omit<import("../lib/map-shares-stores.js").CancelMapShareOptions, "projectId">, unknown>;
+}> & {
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<Promise<void>, Error, Omit<import("../lib/map-shares-stores.js").CancelMapShareOptions, "projectId">, unknown>;
+}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverErrorResult<Promise<void>, Error, Omit<import("../lib/map-shares-stores.js").CancelMapShareOptions, "projectId">, unknown>, {
+    mutate: import("@tanstack/react-query").UseMutateFunction<Promise<void>, Error, Omit<import("../lib/map-shares-stores.js").CancelMapShareOptions, "projectId">, unknown>;
+}> & {
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<Promise<void>, Error, Omit<import("../lib/map-shares-stores.js").CancelMapShareOptions, "projectId">, unknown>;
+}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverSuccessResult<Promise<void>, Error, Omit<import("../lib/map-shares-stores.js").CancelMapShareOptions, "projectId">, unknown>, {
+    mutate: import("@tanstack/react-query").UseMutateFunction<Promise<void>, Error, Omit<import("../lib/map-shares-stores.js").CancelMapShareOptions, "projectId">, unknown>;
+}> & {
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<Promise<void>, Error, Omit<import("../lib/map-shares-stores.js").CancelMapShareOptions, "projectId">, unknown>;
+}, "error" | "status" | "mutate" | "reset" | "mutateAsync">;
+/**
+ * Track the status and progress of a sent map share. Returns the current state
+ * of the share, updated in real-time. When the recipient starts downloading, or
+ * if they decline the share, then the returned share will update.
+ *
+ * Throws if no share with the specified ID is found.
+ *
+ * @param opts.shareId ID of the sent map share
+ *
+ * @example
+ * ```tsx
+ * function SentShareStatus({ shareId }: { shareId: string }) {
+ *   const mapShare = useSingleSentMapShare({ shareId })
+ *
+ *   return (<div>
+ * 		<div>Share status: {mapShare.status}</div>
+ *    {mapShare.status === 'pending' && <div>Waiting for recipient to accept...</div>}
+ *   	{mapShare.status === 'downloading' && (<div>Download in progress: {mapShare.downloadProgress}%</div>)}
+ *   	{mapShare.status === 'declined' && <div>Share was declined by recipient</div>}
+ * 	  {mapShare.status === 'canceled' && <div>Share was canceled</div>}
+ *   </div>)
+ * }
+ * ```
+ */
+export declare function useSingleSentMapShare({ shareId, }: {
+    shareId: string;
+}): SentMapShareState;