@comapeo/core-react 11.0.0 → 11.0.2

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

@@ -141,6 +141,9 @@ export declare function useManyReceivedMapShares(): ReceivedMapShareState[];
  *
  * @param opts.shareId ID of the map share
  *
+ * @throws An error with code `'MAP_SHARE_NOT_FOUND'` if no received share
+ *   with the given `shareId` exists.
+ *
  * @example
  * ```tsx
  * function MapShareDetail({ shareId }: { shareId: string }) {
@@ -165,11 +168,14 @@ export declare function useSingleReceivedMapShare({ shareId }: {
  * receiver discovers that a share has been canceled — check `share.status`
  * after the download settles.
  *
- * @throws {MapShareCanceledError} If the share is already known to be canceled
- *   (i.e. `status` is `'canceled'` in the store, e.g. after a previous
- *   download attempt discovered the cancellation).
- * @throws {InvalidStatusTransitionError} If the share is not in a valid state
- *   to start downloading (e.g. already downloading, completed, or declined).
+ * @throws An error with code `'MAP_SHARE_CANCELED'` if the share is already
+ *   known to be canceled (i.e. `status` is `'canceled'` in the store, e.g.
+ *   after a previous download attempt discovered the cancellation).
+ * @throws An error with code `'INVALID_STATUS_TRANSITION'` if the share is
+ *   not in a valid state to start downloading (e.g. already downloading,
+ *   completed, or declined).
+ * @throws An error with code `'MAP_SHARE_NOT_FOUND'` if no share with the
+ *   given `shareId` exists in the store.
  *
  * @example
  * ```tsx
@@ -206,12 +212,15 @@ export declare function useDownloadReceivedMapShare(): Pick<import("@tanstack/re
  * share status will transition to `'canceled'` (not `'error'`) and the
  * mutation will throw a `MapShareCanceledError`.
  *
- * @throws {MapShareCanceledError} If the share is already known to be
- *   canceled, or if the server reports that the sender canceled the share
- *   while the decline was in flight. In both cases `share.status` will be
- *   `'canceled'`.
- * @throws {InvalidStatusTransitionError} If the share is not in
- *   `status='pending'` (e.g. already downloading, completed, or declined).
+ * @throws An error with code `'MAP_SHARE_CANCELED'` if the share is already
+ *   known to be canceled, or if the server reports that the sender canceled
+ *   the share while the decline was in flight. In both cases `share.status`
+ *   will be `'canceled'`.
+ * @throws An error with code `'INVALID_STATUS_TRANSITION'` if the share is
+ *   not in `status='pending'` (e.g. already downloading, completed, or
+ *   declined).
+ * @throws An error with code `'MAP_SHARE_NOT_FOUND'` if no share with the
+ *   given `shareId` exists in the store.
  *
  * @example
  * ```tsx
@@ -247,10 +256,15 @@ export declare function useDeclineReceivedMapShare(): Pick<import("@tanstack/rea
 /**
  * Abort an in-progress map share download.
  *
- * @throws {MapShareCanceledError} If the share is already known to be canceled.
- * @throws {InvalidStatusTransitionError} If the share is not in
- *   `status='downloading'` (e.g. still pending, already completed, or
+ * @throws An error with code `'MAP_SHARE_CANCELED'` if the share is already
+ *   known to be canceled.
+ * @throws An error with code `'INVALID_STATUS_TRANSITION'` if the share is
+ *   not in `status='downloading'` (e.g. still pending, already completed, or
  *   declined).
+ * @throws An error with code `'MAP_SHARE_NOT_FOUND'` if no share with the
+ *   given `shareId` exists in the store.
+ * @throws An error with code `'DOWNLOAD_NOT_FOUND'` if no download is
+ *   currently tracked for this share (e.g. the download was never started).
  *
  * @example
  * ```tsx
@@ -329,6 +343,12 @@ export declare function useSendMapShare(): Pick<import("@tanstack/react-query").
  * the share, the download will be canceled before completion. If the download
  * is already complete, this action will throw an error.
  *
+ * @throws An error with code `'INVALID_STATUS_TRANSITION'` if the share is
+ *   not in `status='pending'` or `status='downloading'` (e.g. already
+ *   completed, canceled, aborted, or declined).
+ * @throws An error with code `'MAP_SHARE_NOT_FOUND'` if no share with the
+ *   given `shareId` exists in the store.
+ *
  * @param opts.projectId Public ID of project to request the map share cancellation for.
  *
  * @example
@@ -362,7 +382,8 @@ export declare function useCancelSentMapShare(): Pick<import("@tanstack/react-qu
  * 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.
+ * @throws An error with code `'MAP_SHARE_NOT_FOUND'` if no sent share with
+ *   the given `shareId` exists in the store.
  *
  * @param opts.shareId ID of the sent map share
  *

package/dist/commonjs/hooks/maps.js

@@ -163,6 +163,9 @@ function useManyReceivedMapShares() {
  *
  * @param opts.shareId ID of the map share
  *
+ * @throws An error with code `'MAP_SHARE_NOT_FOUND'` if no received share
+ *   with the given `shareId` exists.
+ *
  * @example
  * ```tsx
  * function MapShareDetail({ shareId }: { shareId: string }) {
@@ -175,7 +178,7 @@ function useManyReceivedMapShares() {
 function useSingleReceivedMapShare({ shareId }) {
     const mapShare = (0, MapShares_js_1.useReceivedMapSharesState)((0, react_1.useCallback)((shares) => shares.find((s) => s.shareId === shareId), [shareId]));
     if (!mapShare) {
-        throw new Error(`Map share with id ${shareId} not found`);
+        throw new errors_js_1.errors.MAP_SHARE_NOT_FOUND(`Received map share with id ${shareId} not found`);
     }
     return mapShare;
 }
@@ -191,11 +194,14 @@ function useSingleReceivedMapShare({ shareId }) {
  * receiver discovers that a share has been canceled — check `share.status`
  * after the download settles.
  *
- * @throws {MapShareCanceledError} If the share is already known to be canceled
- *   (i.e. `status` is `'canceled'` in the store, e.g. after a previous
- *   download attempt discovered the cancellation).
- * @throws {InvalidStatusTransitionError} If the share is not in a valid state
- *   to start downloading (e.g. already downloading, completed, or declined).
+ * @throws An error with code `'MAP_SHARE_CANCELED'` if the share is already
+ *   known to be canceled (i.e. `status` is `'canceled'` in the store, e.g.
+ *   after a previous download attempt discovered the cancellation).
+ * @throws An error with code `'INVALID_STATUS_TRANSITION'` if the share is
+ *   not in a valid state to start downloading (e.g. already downloading,
+ *   completed, or declined).
+ * @throws An error with code `'MAP_SHARE_NOT_FOUND'` if no share with the
+ *   given `shareId` exists in the store.
  *
  * @example
  * ```tsx
@@ -224,12 +230,15 @@ function useDownloadReceivedMapShare() {
  * share status will transition to `'canceled'` (not `'error'`) and the
  * mutation will throw a `MapShareCanceledError`.
  *
- * @throws {MapShareCanceledError} If the share is already known to be
- *   canceled, or if the server reports that the sender canceled the share
- *   while the decline was in flight. In both cases `share.status` will be
- *   `'canceled'`.
- * @throws {InvalidStatusTransitionError} If the share is not in
- *   `status='pending'` (e.g. already downloading, completed, or declined).
+ * @throws An error with code `'MAP_SHARE_CANCELED'` if the share is already
+ *   known to be canceled, or if the server reports that the sender canceled
+ *   the share while the decline was in flight. In both cases `share.status`
+ *   will be `'canceled'`.
+ * @throws An error with code `'INVALID_STATUS_TRANSITION'` if the share is
+ *   not in `status='pending'` (e.g. already downloading, completed, or
+ *   declined).
+ * @throws An error with code `'MAP_SHARE_NOT_FOUND'` if no share with the
+ *   given `shareId` exists in the store.
  *
  * @example
  * ```tsx
@@ -257,10 +266,15 @@ function useDeclineReceivedMapShare() {
 /**
  * Abort an in-progress map share download.
  *
- * @throws {MapShareCanceledError} If the share is already known to be canceled.
- * @throws {InvalidStatusTransitionError} If the share is not in
- *   `status='downloading'` (e.g. still pending, already completed, or
+ * @throws An error with code `'MAP_SHARE_CANCELED'` if the share is already
+ *   known to be canceled.
+ * @throws An error with code `'INVALID_STATUS_TRANSITION'` if the share is
+ *   not in `status='downloading'` (e.g. still pending, already completed, or
  *   declined).
+ * @throws An error with code `'MAP_SHARE_NOT_FOUND'` if no share with the
+ *   given `shareId` exists in the store.
+ * @throws An error with code `'DOWNLOAD_NOT_FOUND'` if no download is
+ *   currently tracked for this share (e.g. the download was never started).
  *
  * @example
  * ```tsx
@@ -326,6 +340,12 @@ function useSendMapShare() {
  * the share, the download will be canceled before completion. If the download
  * is already complete, this action will throw an error.
  *
+ * @throws An error with code `'INVALID_STATUS_TRANSITION'` if the share is
+ *   not in `status='pending'` or `status='downloading'` (e.g. already
+ *   completed, canceled, aborted, or declined).
+ * @throws An error with code `'MAP_SHARE_NOT_FOUND'` if no share with the
+ *   given `shareId` exists in the store.
+ *
  * @param opts.projectId Public ID of project to request the map share cancellation for.
  *
  * @example
@@ -351,7 +371,8 @@ function useCancelSentMapShare() {
  * 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.
+ * @throws An error with code `'MAP_SHARE_NOT_FOUND'` if no sent share with
+ *   the given `shareId` exists in the store.
  *
  * @param opts.shareId ID of the sent map share
  *

package/dist/commonjs/lib/react-query.d.ts

@@ -54,8 +54,8 @@ export declare function getProjectRoleQueryKey({ projectId }: {
 export declare function getMembersQueryKey({ projectId, includeLeft, }: {
     projectId: string;
     includeLeft?: boolean;
-}): readonly ["@comapeo/core-react", "projects", string, "members", {
-    readonly includeLeft: boolean | undefined;
+}): readonly ["@comapeo/core-react", "projects", string, "members"] | readonly ["@comapeo/core-react", "projects", string, "members", {
+    readonly includeLeft: boolean;
 }];
 export declare function getMemberByIdQueryKey({ projectId, deviceId, }: {
     projectId: string;

package/dist/commonjs/lib/react-query.js

@@ -23,7 +23,7 @@ exports.getDocumentsQueryKey = getDocumentsQueryKey;
 exports.getManyDocumentsQueryKey = getManyDocumentsQueryKey;
 exports.getDocumentByDocIdQueryKey = getDocumentByDocIdQueryKey;
 exports.getDocumentByVersionIdQueryKey = getDocumentByVersionIdQueryKey;
-const map_server_1 = require("@comapeo/map-server");
+const constants_js_1 = require("@comapeo/map-server/constants.js");
 // #region Shared
 const ROOT_QUERY_KEY = '@comapeo/core-react';
 // Since the API is running locally, queries should run regardless of network
@@ -103,7 +103,7 @@ async function invalidateMapQueries(queryClient, { mapId }) {
             queryKey: getMapQueryKey({ mapId }),
         }),
         queryClient.invalidateQueries({
-            queryKey: getMapQueryKey({ mapId: map_server_1.DEFAULT_MAP_ID }),
+            queryKey: getMapQueryKey({ mapId: constants_js_1.DEFAULT_MAP_ID }),
         }),
     ]);
 }
@@ -122,13 +122,15 @@ function getProjectRoleQueryKey({ projectId }) {
     return [ROOT_QUERY_KEY, 'projects', projectId, 'role'];
 }
 function getMembersQueryKey({ projectId, includeLeft, }) {
-    return [
-        ROOT_QUERY_KEY,
-        'projects',
-        projectId,
-        'members',
-        { includeLeft },
-    ];
+    return includeLeft === undefined
+        ? [ROOT_QUERY_KEY, 'projects', projectId, 'members']
+        : [
+            ROOT_QUERY_KEY,
+            'projects',
+            projectId,
+            'members',
+            { includeLeft },
+        ];
 }
 function getMemberByIdQueryKey({ projectId, deviceId, }) {
     return [ROOT_QUERY_KEY, 'projects', projectId, 'members', deviceId];

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

@@ -141,6 +141,9 @@ export declare function useManyReceivedMapShares(): ReceivedMapShareState[];
  *
  * @param opts.shareId ID of the map share
  *
+ * @throws An error with code `'MAP_SHARE_NOT_FOUND'` if no received share
+ *   with the given `shareId` exists.
+ *
  * @example
  * ```tsx
  * function MapShareDetail({ shareId }: { shareId: string }) {
@@ -165,11 +168,14 @@ export declare function useSingleReceivedMapShare({ shareId }: {
  * receiver discovers that a share has been canceled — check `share.status`
  * after the download settles.
  *
- * @throws {MapShareCanceledError} If the share is already known to be canceled
- *   (i.e. `status` is `'canceled'` in the store, e.g. after a previous
- *   download attempt discovered the cancellation).
- * @throws {InvalidStatusTransitionError} If the share is not in a valid state
- *   to start downloading (e.g. already downloading, completed, or declined).
+ * @throws An error with code `'MAP_SHARE_CANCELED'` if the share is already
+ *   known to be canceled (i.e. `status` is `'canceled'` in the store, e.g.
+ *   after a previous download attempt discovered the cancellation).
+ * @throws An error with code `'INVALID_STATUS_TRANSITION'` if the share is
+ *   not in a valid state to start downloading (e.g. already downloading,
+ *   completed, or declined).
+ * @throws An error with code `'MAP_SHARE_NOT_FOUND'` if no share with the
+ *   given `shareId` exists in the store.
  *
  * @example
  * ```tsx
@@ -206,12 +212,15 @@ export declare function useDownloadReceivedMapShare(): Pick<import("@tanstack/re
  * share status will transition to `'canceled'` (not `'error'`) and the
  * mutation will throw a `MapShareCanceledError`.
  *
- * @throws {MapShareCanceledError} If the share is already known to be
- *   canceled, or if the server reports that the sender canceled the share
- *   while the decline was in flight. In both cases `share.status` will be
- *   `'canceled'`.
- * @throws {InvalidStatusTransitionError} If the share is not in
- *   `status='pending'` (e.g. already downloading, completed, or declined).
+ * @throws An error with code `'MAP_SHARE_CANCELED'` if the share is already
+ *   known to be canceled, or if the server reports that the sender canceled
+ *   the share while the decline was in flight. In both cases `share.status`
+ *   will be `'canceled'`.
+ * @throws An error with code `'INVALID_STATUS_TRANSITION'` if the share is
+ *   not in `status='pending'` (e.g. already downloading, completed, or
+ *   declined).
+ * @throws An error with code `'MAP_SHARE_NOT_FOUND'` if no share with the
+ *   given `shareId` exists in the store.
  *
  * @example
  * ```tsx
@@ -247,10 +256,15 @@ export declare function useDeclineReceivedMapShare(): Pick<import("@tanstack/rea
 /**
  * Abort an in-progress map share download.
  *
- * @throws {MapShareCanceledError} If the share is already known to be canceled.
- * @throws {InvalidStatusTransitionError} If the share is not in
- *   `status='downloading'` (e.g. still pending, already completed, or
+ * @throws An error with code `'MAP_SHARE_CANCELED'` if the share is already
+ *   known to be canceled.
+ * @throws An error with code `'INVALID_STATUS_TRANSITION'` if the share is
+ *   not in `status='downloading'` (e.g. still pending, already completed, or
  *   declined).
+ * @throws An error with code `'MAP_SHARE_NOT_FOUND'` if no share with the
+ *   given `shareId` exists in the store.
+ * @throws An error with code `'DOWNLOAD_NOT_FOUND'` if no download is
+ *   currently tracked for this share (e.g. the download was never started).
  *
  * @example
  * ```tsx
@@ -329,6 +343,12 @@ export declare function useSendMapShare(): Pick<import("@tanstack/react-query").
  * the share, the download will be canceled before completion. If the download
  * is already complete, this action will throw an error.
  *
+ * @throws An error with code `'INVALID_STATUS_TRANSITION'` if the share is
+ *   not in `status='pending'` or `status='downloading'` (e.g. already
+ *   completed, canceled, aborted, or declined).
+ * @throws An error with code `'MAP_SHARE_NOT_FOUND'` if no share with the
+ *   given `shareId` exists in the store.
+ *
  * @param opts.projectId Public ID of project to request the map share cancellation for.
  *
  * @example
@@ -362,7 +382,8 @@ export declare function useCancelSentMapShare(): Pick<import("@tanstack/react-qu
  * 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.
+ * @throws An error with code `'MAP_SHARE_NOT_FOUND'` if no sent share with
+ *   the given `shareId` exists in the store.
  *
  * @param opts.shareId ID of the sent map share
  *

package/dist/esm/hooks/maps.js

@@ -149,6 +149,9 @@ export function useManyReceivedMapShares() {
  *
  * @param opts.shareId ID of the map share
  *
+ * @throws An error with code `'MAP_SHARE_NOT_FOUND'` if no received share
+ *   with the given `shareId` exists.
+ *
  * @example
  * ```tsx
  * function MapShareDetail({ shareId }: { shareId: string }) {
@@ -161,7 +164,7 @@ export function useManyReceivedMapShares() {
 export function useSingleReceivedMapShare({ shareId }) {
     const mapShare = useReceivedMapSharesState(useCallback((shares) => shares.find((s) => s.shareId === shareId), [shareId]));
     if (!mapShare) {
-        throw new Error(`Map share with id ${shareId} not found`);
+        throw new errors.MAP_SHARE_NOT_FOUND(`Received map share with id ${shareId} not found`);
     }
     return mapShare;
 }
@@ -177,11 +180,14 @@ export function useSingleReceivedMapShare({ shareId }) {
  * receiver discovers that a share has been canceled — check `share.status`
  * after the download settles.
  *
- * @throws {MapShareCanceledError} If the share is already known to be canceled
- *   (i.e. `status` is `'canceled'` in the store, e.g. after a previous
- *   download attempt discovered the cancellation).
- * @throws {InvalidStatusTransitionError} If the share is not in a valid state
- *   to start downloading (e.g. already downloading, completed, or declined).
+ * @throws An error with code `'MAP_SHARE_CANCELED'` if the share is already
+ *   known to be canceled (i.e. `status` is `'canceled'` in the store, e.g.
+ *   after a previous download attempt discovered the cancellation).
+ * @throws An error with code `'INVALID_STATUS_TRANSITION'` if the share is
+ *   not in a valid state to start downloading (e.g. already downloading,
+ *   completed, or declined).
+ * @throws An error with code `'MAP_SHARE_NOT_FOUND'` if no share with the
+ *   given `shareId` exists in the store.
  *
  * @example
  * ```tsx
@@ -210,12 +216,15 @@ export function useDownloadReceivedMapShare() {
  * share status will transition to `'canceled'` (not `'error'`) and the
  * mutation will throw a `MapShareCanceledError`.
  *
- * @throws {MapShareCanceledError} If the share is already known to be
- *   canceled, or if the server reports that the sender canceled the share
- *   while the decline was in flight. In both cases `share.status` will be
- *   `'canceled'`.
- * @throws {InvalidStatusTransitionError} If the share is not in
- *   `status='pending'` (e.g. already downloading, completed, or declined).
+ * @throws An error with code `'MAP_SHARE_CANCELED'` if the share is already
+ *   known to be canceled, or if the server reports that the sender canceled
+ *   the share while the decline was in flight. In both cases `share.status`
+ *   will be `'canceled'`.
+ * @throws An error with code `'INVALID_STATUS_TRANSITION'` if the share is
+ *   not in `status='pending'` (e.g. already downloading, completed, or
+ *   declined).
+ * @throws An error with code `'MAP_SHARE_NOT_FOUND'` if no share with the
+ *   given `shareId` exists in the store.
  *
  * @example
  * ```tsx
@@ -243,10 +252,15 @@ export function useDeclineReceivedMapShare() {
 /**
  * Abort an in-progress map share download.
  *
- * @throws {MapShareCanceledError} If the share is already known to be canceled.
- * @throws {InvalidStatusTransitionError} If the share is not in
- *   `status='downloading'` (e.g. still pending, already completed, or
+ * @throws An error with code `'MAP_SHARE_CANCELED'` if the share is already
+ *   known to be canceled.
+ * @throws An error with code `'INVALID_STATUS_TRANSITION'` if the share is
+ *   not in `status='downloading'` (e.g. still pending, already completed, or
  *   declined).
+ * @throws An error with code `'MAP_SHARE_NOT_FOUND'` if no share with the
+ *   given `shareId` exists in the store.
+ * @throws An error with code `'DOWNLOAD_NOT_FOUND'` if no download is
+ *   currently tracked for this share (e.g. the download was never started).
  *
  * @example
  * ```tsx
@@ -312,6 +326,12 @@ export function useSendMapShare() {
  * the share, the download will be canceled before completion. If the download
  * is already complete, this action will throw an error.
  *
+ * @throws An error with code `'INVALID_STATUS_TRANSITION'` if the share is
+ *   not in `status='pending'` or `status='downloading'` (e.g. already
+ *   completed, canceled, aborted, or declined).
+ * @throws An error with code `'MAP_SHARE_NOT_FOUND'` if no share with the
+ *   given `shareId` exists in the store.
+ *
  * @param opts.projectId Public ID of project to request the map share cancellation for.
  *
  * @example
@@ -337,7 +357,8 @@ export function useCancelSentMapShare() {
  * 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.
+ * @throws An error with code `'MAP_SHARE_NOT_FOUND'` if no sent share with
+ *   the given `shareId` exists in the store.
  *
  * @param opts.shareId ID of the sent map share
  *

package/dist/esm/lib/react-query.d.ts

@@ -54,8 +54,8 @@ export declare function getProjectRoleQueryKey({ projectId }: {
 export declare function getMembersQueryKey({ projectId, includeLeft, }: {
     projectId: string;
     includeLeft?: boolean;
-}): readonly ["@comapeo/core-react", "projects", string, "members", {
-    readonly includeLeft: boolean | undefined;
+}): readonly ["@comapeo/core-react", "projects", string, "members"] | readonly ["@comapeo/core-react", "projects", string, "members", {
+    readonly includeLeft: boolean;
 }];
 export declare function getMemberByIdQueryKey({ projectId, deviceId, }: {
     projectId: string;

package/dist/esm/lib/react-query.js

@@ -1,4 +1,4 @@
-import { DEFAULT_MAP_ID } from '@comapeo/map-server';
+import { DEFAULT_MAP_ID } from '@comapeo/map-server/constants.js';
 // #region Shared
 const ROOT_QUERY_KEY = '@comapeo/core-react';
 // Since the API is running locally, queries should run regardless of network
@@ -97,13 +97,15 @@ export function getProjectRoleQueryKey({ projectId }) {
     return [ROOT_QUERY_KEY, 'projects', projectId, 'role'];
 }
 export function getMembersQueryKey({ projectId, includeLeft, }) {
-    return [
-        ROOT_QUERY_KEY,
-        'projects',
-        projectId,
-        'members',
-        { includeLeft },
-    ];
+    return includeLeft === undefined
+        ? [ROOT_QUERY_KEY, 'projects', projectId, 'members']
+        : [
+            ROOT_QUERY_KEY,
+            'projects',
+            projectId,
+            'members',
+            { includeLeft },
+        ];
 }
 export function getMemberByIdQueryKey({ projectId, deviceId, }) {
     return [ROOT_QUERY_KEY, 'projects', projectId, 'members', deviceId];

package/docs/API.md

@@ -1231,10 +1231,14 @@ function MapShareDetail({ shareId }: { shareId: string }) {
 
 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.
+Use `useManyReceivedMapShares` or `useSingleReceivedMapShare` to track
+download progress and final status.
 
-Throws if the share is not in `status="pending"` or if the download fails to
-start (e.g. if the shareId if invalid).
+If the sender canceled the share before the receiver calls this, the
+mutation will still resolve (the download starts), but the share status will
+end up as `'canceled'` rather than `'completed'`. This is the only way the
+receiver discovers that a share has been canceled — check `share.status`
+after the download settles.
 
 | Function | Type |
 | ---------- | ---------- |
@@ -1244,7 +1248,7 @@ Examples:
 
 ```tsx
 function AcceptButton({ shareId }: { shareId: string }) {
-  const { mutate: accept } = useAcceptMapShare()
+  const { mutate: accept } = useDownloadReceivedMapShare()
 
   return <button onClick={() => accept({ shareId })}>Accept</button>
 }
@@ -1254,11 +1258,12 @@ function AcceptButton({ shareId }: { shareId: string }) {
 ### useDeclineReceivedMapShare
 
 Decline a map share that has been received. Notifies the sender that the
-share was declined.
+share was declined. The share status is only updated to `'declined'` after
+the server confirms the decline — there is no optimistic update.
 
-Throws if the share is not with `status="pending"`
-Throws if shareId is invalid
-Throws if decline request fails (e.g. network error)
+If the sender canceled the share before the decline reaches the server, the
+share status will transition to `'canceled'` (not `'error'`) and the
+mutation will throw a `MapShareCanceledError`.
 
 | Function | Type |
 | ---------- | ---------- |
@@ -1269,7 +1274,7 @@ Examples:
 ```tsx
 import { DeclineReason } from '@comapeo/core-react'
 function DeclineButton({ shareId }: { shareId: string }) {
-  const { mutate: decline } = useDeclineMapShare()
+  const { mutate: decline } = useDeclineReceivedMapShare()
 
   return (
     <button onClick={() => decline({ shareId, reason: DeclineReason.user_rejected })}>
@@ -1284,9 +1289,6 @@ function DeclineButton({ shareId }: { shareId: string }) {
 
 Abort an in-progress map share download.
 
-Throws if the share is not in `status="downloading"`
-Throws if shareId is invalid
-
 | Function | Type |
 | ---------- | ---------- |
 | `useAbortReceivedMapShareDownload` | `() => Pick<Override<MutationObserverIdleResult<void, Error, AbortMapShareOptions, unknown>, { mutate: UseMutateFunction<void, Error, AbortMapShareOptions, unknown>; }> and { ...; }, "error" or ... 3 more ... or "mutateAsync"> or Pick<...> or Pick<...> or Pick<...>` |
@@ -1295,7 +1297,7 @@ Examples:
 
 ```tsx
 function AbortButton({ shareId }: { shareId: string }) {
-  const { mutate: abort } = useAbortMapShareDownload()
+  const { mutate: abort } = useAbortReceivedMapShareDownload()
 
   return <button onClick={() => abort({ shareId })}>Cancel Download</button>
 }
@@ -1370,8 +1372,6 @@ 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.
-
 | Function | Type |
 | ---------- | ---------- |
 | `useSingleSentMapShare` | `({ shareId, }: { shareId: string; }) => ServerMapShareState` |

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@comapeo/core-react",
-	"version": "11.0.0",
+	"version": "11.0.2",
 	"description": "React wrapper for working with @comapeo/core",
 	"repository": {
 		"type": "git",