@comapeo/core-react 3.2.0 → 4.0.0

package/dist/commonjs/hooks/projects.js

@@ -292,10 +292,10 @@ function useOwnRoleInProject({ projectId }) {
 function useAddServerPeer({ projectId }) {
     const queryClient = (0, react_query_1.useQueryClient)();
     const { data: projectApi } = useSingleProject({ projectId });
-    const { error, mutate, reset, status } = (0, react_query_1.useMutation)((0, projects_js_1.addServerPeerMutationOptions)({ projectApi, projectId, queryClient }));
+    const { error, mutate, mutateAsync, reset, status } = (0, react_query_1.useMutation)((0, projects_js_1.addServerPeerMutationOptions)({ projectApi, projectId, queryClient }));
     return status === 'error'
-        ? { error, mutate, reset, status }
-        : { error: null, mutate, reset, status };
+        ? { error, mutate, mutateAsync, reset, status }
+        : { error: null, mutate, mutateAsync, reset, status };
 }
 /**
  * Create a new project.
@@ -303,10 +303,10 @@ function useAddServerPeer({ projectId }) {
 function useCreateProject() {
     const queryClient = (0, react_query_1.useQueryClient)();
     const clientApi = (0, client_js_1.useClientApi)();
-    const { error, mutate, reset, status } = (0, react_query_1.useMutation)((0, projects_js_1.createProjectMutationOptions)({ clientApi, queryClient }));
+    const { error, mutate, mutateAsync, reset, status } = (0, react_query_1.useMutation)((0, projects_js_1.createProjectMutationOptions)({ clientApi, queryClient }));
     return status === 'error'
-        ? { error, mutate, reset, status }
-        : { error: null, mutate, reset, status };
+        ? { error, mutate, mutateAsync, reset, status }
+        : { error: null, mutate, mutateAsync, reset, status };
 }
 /**
  * Leave an existing project.
@@ -314,10 +314,10 @@ function useCreateProject() {
 function useLeaveProject() {
     const queryClient = (0, react_query_1.useQueryClient)();
     const clientApi = (0, client_js_1.useClientApi)();
-    const { error, mutate, reset, status } = (0, react_query_1.useMutation)((0, projects_js_1.leaveProjectMutationOptions)({ clientApi, queryClient }));
+    const { error, mutate, mutateAsync, reset, status } = (0, react_query_1.useMutation)((0, projects_js_1.leaveProjectMutationOptions)({ clientApi, queryClient }));
     return status === 'error'
-        ? { error, mutate, reset, status }
-        : { error: null, mutate, reset, status };
+        ? { error, mutate, mutateAsync, reset, status }
+        : { error: null, mutate, mutateAsync, reset, status };
 }
 /**
  * Update the configuration of a project using an external file.
@@ -327,10 +327,10 @@ function useLeaveProject() {
 function useImportProjectConfig({ projectId }) {
     const queryClient = (0, react_query_1.useQueryClient)();
     const { data: projectApi } = useSingleProject({ projectId });
-    const { error, mutate, reset, status } = (0, react_query_1.useMutation)((0, projects_js_1.importProjectConfigMutationOptions)({ queryClient, projectApi, projectId }));
+    const { error, mutate, mutateAsync, reset, status } = (0, react_query_1.useMutation)((0, projects_js_1.importProjectConfigMutationOptions)({ queryClient, projectApi, projectId }));
     return status === 'error'
-        ? { error, mutate, reset, status }
-        : { error: null, mutate, reset, status };
+        ? { error, mutate, mutateAsync, reset, status }
+        : { error: null, mutate, mutateAsync, reset, status };
 }
 /**
  * Update the settings of a project.
@@ -340,10 +340,10 @@ function useImportProjectConfig({ projectId }) {
 function useUpdateProjectSettings({ projectId }) {
     const queryClient = (0, react_query_1.useQueryClient)();
     const { data: projectApi } = useSingleProject({ projectId });
-    const { error, mutate, reset, status } = (0, react_query_1.useMutation)((0, projects_js_1.updateProjectSettingsMutationOptions)({ projectApi, queryClient }));
+    const { error, mutate, mutateAsync, reset, status } = (0, react_query_1.useMutation)((0, projects_js_1.updateProjectSettingsMutationOptions)({ projectApi, queryClient }));
     return status === 'error'
-        ? { error, mutate, reset, status }
-        : { error: null, mutate, reset, status };
+        ? { error, mutate, mutateAsync, reset, status }
+        : { error: null, mutate, mutateAsync, reset, status };
 }
 /**
  * Create a blob for a project.
@@ -352,10 +352,10 @@ function useUpdateProjectSettings({ projectId }) {
  */
 function useCreateBlob({ projectId }) {
     const { data: projectApi } = useSingleProject({ projectId });
-    const { error, mutate, reset, status } = (0, react_query_1.useMutation)((0, projects_js_1.createBlobMutationOptions)({ projectApi }));
+    const { error, mutate, mutateAsync, reset, status } = (0, react_query_1.useMutation)((0, projects_js_1.createBlobMutationOptions)({ projectApi }));
     return status === 'error'
-        ? { error, mutate, reset, status }
-        : { error: null, mutate, reset, status };
+        ? { error, mutate, mutateAsync, reset, status }
+        : { error: null, mutate, mutateAsync, reset, status };
 }
 const PROJECT_SYNC_STORE_MAP = new WeakMap();
 function useSyncStore({ projectId }) {
@@ -405,15 +405,15 @@ function useDataSyncProgress({ projectId, }) {
 }
 function useStartSync({ projectId }) {
     const { data: projectApi } = useSingleProject({ projectId });
-    const { mutate, reset, status, error } = (0, react_query_1.useMutation)((0, projects_js_1.startSyncMutationOptions)({ projectApi }));
+    const { error, mutate, mutateAsync, reset, status } = (0, react_query_1.useMutation)((0, projects_js_1.startSyncMutationOptions)({ projectApi }));
     return status === 'error'
-        ? { error, mutate, reset, status }
-        : { error: null, mutate, reset, status };
+        ? { error, mutate, mutateAsync, reset, status }
+        : { error: null, mutate, mutateAsync, reset, status };
 }
 function useStopSync({ projectId }) {
     const { data: projectApi } = useSingleProject({ projectId });
-    const { error, mutate, reset, status } = (0, react_query_1.useMutation)((0, projects_js_1.stopSyncMutationOptions)({ projectApi }));
+    const { error, mutate, mutateAsync, reset, status } = (0, react_query_1.useMutation)((0, projects_js_1.stopSyncMutationOptions)({ projectApi }));
     return status === 'error'
-        ? { error, mutate, reset, status }
-        : { error: null, mutate, reset, status };
+        ? { error, mutate, mutateAsync, reset, status }
+        : { error: null, mutate, mutateAsync, reset, status };
 }

package/dist/commonjs/index.d.ts

@@ -1,7 +1,7 @@
 export { ClientApiContext, ClientApiProvider } from './contexts/ClientApi.js';
 export { useClientApi, useIsArchiveDevice, useOwnDeviceInfo, useSetIsArchiveDevice, useSetOwnDeviceInfo, } from './hooks/client.js';
 export { useCreateDocument, useDeleteDocument, useManyDocs, useSingleDocByDocId, useSingleDocByVersionId, useUpdateDocument, } from './hooks/documents.js';
-export { useAcceptInvite, useRejectInvite, useRequestCancelInvite, useSendInvite, } from './hooks/invites.js';
+export { useAcceptInvite, useSetUpInvitesListeners, useManyInvites, useRejectInvite, useRequestCancelInvite, useSendInvite, useSingleInvite, } from './hooks/invites.js';
 export { useMapStyleUrl } from './hooks/maps.js';
 export { useAddServerPeer, useAttachmentUrl, useCreateBlob, useCreateProject, useDataSyncProgress, useDocumentCreatedBy, useIconUrl, useImportProjectConfig, useLeaveProject, useManyMembers, useManyProjects, useOwnRoleInProject, useProjectSettings, useSingleMember, useSingleProject, useStartSync, useStopSync, useSyncState, useUpdateProjectSettings, } from './hooks/projects.js';
 export { type SyncState } from './lib/sync.js';

package/dist/commonjs/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.useUpdateProjectSettings = exports.useSyncState = exports.useStopSync = exports.useStartSync = exports.useSingleProject = exports.useSingleMember = exports.useProjectSettings = exports.useOwnRoleInProject = exports.useManyProjects = exports.useManyMembers = exports.useLeaveProject = exports.useImportProjectConfig = exports.useIconUrl = exports.useDocumentCreatedBy = exports.useDataSyncProgress = exports.useCreateProject = exports.useCreateBlob = exports.useAttachmentUrl = exports.useAddServerPeer = exports.useMapStyleUrl = exports.useSendInvite = exports.useRequestCancelInvite = exports.useRejectInvite = exports.useAcceptInvite = exports.useUpdateDocument = exports.useSingleDocByVersionId = exports.useSingleDocByDocId = exports.useManyDocs = exports.useDeleteDocument = exports.useCreateDocument = exports.useSetOwnDeviceInfo = exports.useSetIsArchiveDevice = exports.useOwnDeviceInfo = exports.useIsArchiveDevice = exports.useClientApi = exports.ClientApiProvider = exports.ClientApiContext = void 0;
+exports.useUpdateProjectSettings = exports.useSyncState = exports.useStopSync = exports.useStartSync = exports.useSingleProject = exports.useSingleMember = exports.useProjectSettings = exports.useOwnRoleInProject = exports.useManyProjects = exports.useManyMembers = exports.useLeaveProject = exports.useImportProjectConfig = exports.useIconUrl = exports.useDocumentCreatedBy = exports.useDataSyncProgress = exports.useCreateProject = exports.useCreateBlob = exports.useAttachmentUrl = exports.useAddServerPeer = exports.useMapStyleUrl = exports.useSingleInvite = exports.useSendInvite = exports.useRequestCancelInvite = exports.useRejectInvite = exports.useManyInvites = exports.useSetUpInvitesListeners = exports.useAcceptInvite = exports.useUpdateDocument = exports.useSingleDocByVersionId = exports.useSingleDocByDocId = exports.useManyDocs = exports.useDeleteDocument = exports.useCreateDocument = exports.useSetOwnDeviceInfo = exports.useSetIsArchiveDevice = exports.useOwnDeviceInfo = exports.useIsArchiveDevice = exports.useClientApi = exports.ClientApiProvider = exports.ClientApiContext = void 0;
 var ClientApi_js_1 = require("./contexts/ClientApi.js");
 Object.defineProperty(exports, "ClientApiContext", { enumerable: true, get: function () { return ClientApi_js_1.ClientApiContext; } });
 Object.defineProperty(exports, "ClientApiProvider", { enumerable: true, get: function () { return ClientApi_js_1.ClientApiProvider; } });
@@ -19,9 +19,12 @@ Object.defineProperty(exports, "useSingleDocByVersionId", { enumerable: true, ge
 Object.defineProperty(exports, "useUpdateDocument", { enumerable: true, get: function () { return documents_js_1.useUpdateDocument; } });
 var invites_js_1 = require("./hooks/invites.js");
 Object.defineProperty(exports, "useAcceptInvite", { enumerable: true, get: function () { return invites_js_1.useAcceptInvite; } });
+Object.defineProperty(exports, "useSetUpInvitesListeners", { enumerable: true, get: function () { return invites_js_1.useSetUpInvitesListeners; } });
+Object.defineProperty(exports, "useManyInvites", { enumerable: true, get: function () { return invites_js_1.useManyInvites; } });
 Object.defineProperty(exports, "useRejectInvite", { enumerable: true, get: function () { return invites_js_1.useRejectInvite; } });
 Object.defineProperty(exports, "useRequestCancelInvite", { enumerable: true, get: function () { return invites_js_1.useRequestCancelInvite; } });
 Object.defineProperty(exports, "useSendInvite", { enumerable: true, get: function () { return invites_js_1.useSendInvite; } });
+Object.defineProperty(exports, "useSingleInvite", { enumerable: true, get: function () { return invites_js_1.useSingleInvite; } });
 var maps_js_1 = require("./hooks/maps.js");
 Object.defineProperty(exports, "useMapStyleUrl", { enumerable: true, get: function () { return maps_js_1.useMapStyleUrl; } });
 var projects_js_1 = require("./hooks/projects.js");

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

@@ -8,20 +8,20 @@ export declare function deviceInfoQueryOptions({ clientApi, }: {
     clientApi: MapeoClientApi;
 }): import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<{
     deviceId: string;
-    deviceType: "device_type_unspecified" | "mobile" | "tablet" | "desktop" | "selfHostedServer" | "UNRECOGNIZED";
+    deviceType: "UNRECOGNIZED" | "device_type_unspecified" | "mobile" | "tablet" | "desktop" | "selfHostedServer";
 } & Partial<import("@comapeo/core/dist/schema/client.js", { with: { "resolution-mode": "import" } }).DeviceInfoParam>, Error, {
     deviceId: string;
-    deviceType: "device_type_unspecified" | "mobile" | "tablet" | "desktop" | "selfHostedServer" | "UNRECOGNIZED";
+    deviceType: "UNRECOGNIZED" | "device_type_unspecified" | "mobile" | "tablet" | "desktop" | "selfHostedServer";
 } & Partial<import("@comapeo/core/dist/schema/client.js", { with: { "resolution-mode": "import" } }).DeviceInfoParam>, readonly ["@comapeo/core-react", "client", "device_info"]>, "queryFn"> & {
     queryFn?: import("@tanstack/react-query").QueryFunction<{
         deviceId: string;
-        deviceType: "device_type_unspecified" | "mobile" | "tablet" | "desktop" | "selfHostedServer" | "UNRECOGNIZED";
+        deviceType: "UNRECOGNIZED" | "device_type_unspecified" | "mobile" | "tablet" | "desktop" | "selfHostedServer";
     } & Partial<import("@comapeo/core/dist/schema/client.js", { with: { "resolution-mode": "import" } }).DeviceInfoParam>, readonly ["@comapeo/core-react", "client", "device_info"], never> | undefined;
 } & {
     queryKey: readonly ["@comapeo/core-react", "client", "device_info"] & {
         [dataTagSymbol]: {
             deviceId: string;
-            deviceType: "device_type_unspecified" | "mobile" | "tablet" | "desktop" | "selfHostedServer" | "UNRECOGNIZED";
+            deviceType: "UNRECOGNIZED" | "device_type_unspecified" | "mobile" | "tablet" | "desktop" | "selfHostedServer";
         } & Partial<import("@comapeo/core/dist/schema/client.js", { with: { "resolution-mode": "import" } }).DeviceInfoParam>;
         [dataTagErrorSymbol]: Error;
     };

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

@@ -2,22 +2,35 @@ import type { RoleIdForNewInvite } from '@comapeo/core/dist/roles.js' with { 're
 import type { MapeoClientApi, MapeoProjectApi } from '@comapeo/ipc' with { 'resolution-mode': 'import' };
 import { type QueryClient } from '@tanstack/react-query';
 export declare function getInvitesQueryKey(): readonly ["@comapeo/core-react", "invites"];
-export declare function getPendingInvitesQueryKey(): readonly ["@comapeo/core-react", "invites", {
-    readonly status: "pending";
+export declare function getInvitesByIdQueryKey({ inviteId }: {
+    inviteId: string;
+}): readonly ["@comapeo/core-react", "invites", {
+    readonly inviteId: string;
 }];
-export declare function pendingInvitesQueryOptions({ clientApi, }: {
+export declare function getInvitesQueryOptions({ clientApi, }: {
     clientApi: MapeoClientApi;
-}): import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("@comapeo/core/dist/types.js", { with: { "resolution-mode": "import" } }).MapBuffers<import("@comapeo/core/dist/invite-api.js", { with: { "resolution-mode": "import" } }).InviteInternal>[], Error, import("@comapeo/core/dist/types.js", { with: { "resolution-mode": "import" } }).MapBuffers<import("@comapeo/core/dist/invite-api.js", { with: { "resolution-mode": "import" } }).InviteInternal>[], readonly ["@comapeo/core-react", "invites", {
-    readonly status: "pending";
+}): import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("@comapeo/core/dist/invite/invite-api.js", { with: { "resolution-mode": "import" } }).Invite[], Error, import("@comapeo/core/dist/invite/invite-api.js", { with: { "resolution-mode": "import" } }).Invite[], readonly ["@comapeo/core-react", "invites"]>, "queryFn"> & {
+    queryFn?: import("@tanstack/react-query").QueryFunction<import("@comapeo/core/dist/invite/invite-api.js", { with: { "resolution-mode": "import" } }).Invite[], readonly ["@comapeo/core-react", "invites"], never> | undefined;
+} & {
+    queryKey: readonly ["@comapeo/core-react", "invites"] & {
+        [dataTagSymbol]: import("@comapeo/core/dist/invite/invite-api.js", { with: { "resolution-mode": "import" } }).Invite[];
+        [dataTagErrorSymbol]: Error;
+    };
+};
+export declare function getInviteByIdQueryOptions({ clientApi, inviteId, }: {
+    clientApi: MapeoClientApi;
+    inviteId: string;
+}): import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("@comapeo/core/dist/invite/invite-api.js", { with: { "resolution-mode": "import" } }).Invite, Error, import("@comapeo/core/dist/invite/invite-api.js", { with: { "resolution-mode": "import" } }).Invite, readonly ["@comapeo/core-react", "invites", {
+    readonly inviteId: string;
 }]>, "queryFn"> & {
-    queryFn?: import("@tanstack/react-query").QueryFunction<import("@comapeo/core/dist/types.js", { with: { "resolution-mode": "import" } }).MapBuffers<import("@comapeo/core/dist/invite-api.js", { with: { "resolution-mode": "import" } }).InviteInternal>[], readonly ["@comapeo/core-react", "invites", {
-        readonly status: "pending";
+    queryFn?: import("@tanstack/react-query").QueryFunction<import("@comapeo/core/dist/invite/invite-api.js", { with: { "resolution-mode": "import" } }).Invite, readonly ["@comapeo/core-react", "invites", {
+        readonly inviteId: string;
     }], never> | undefined;
 } & {
     queryKey: readonly ["@comapeo/core-react", "invites", {
-        readonly status: "pending";
+        readonly inviteId: string;
     }] & {
-        [dataTagSymbol]: import("@comapeo/core/dist/types.js", { with: { "resolution-mode": "import" } }).MapBuffers<import("@comapeo/core/dist/invite-api.js", { with: { "resolution-mode": "import" } }).InviteInternal>[];
+        [dataTagSymbol]: import("@comapeo/core/dist/invite/invite-api.js", { with: { "resolution-mode": "import" } }).Invite;
         [dataTagErrorSymbol]: Error;
     };
 };

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

@@ -1,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getInvitesQueryKey = getInvitesQueryKey;
-exports.getPendingInvitesQueryKey = getPendingInvitesQueryKey;
-exports.pendingInvitesQueryOptions = pendingInvitesQueryOptions;
+exports.getInvitesByIdQueryKey = getInvitesByIdQueryKey;
+exports.getInvitesQueryOptions = getInvitesQueryOptions;
+exports.getInviteByIdQueryOptions = getInviteByIdQueryOptions;
 exports.acceptInviteMutationOptions = acceptInviteMutationOptions;
 exports.rejectInviteMutationOptions = rejectInviteMutationOptions;
 exports.sendInviteMutationOptions = sendInviteMutationOptions;
@@ -13,15 +14,24 @@ const shared_js_1 = require("./shared.js");
 function getInvitesQueryKey() {
     return [shared_js_1.ROOT_QUERY_KEY, 'invites'];
 }
-function getPendingInvitesQueryKey() {
-    return [shared_js_1.ROOT_QUERY_KEY, 'invites', { status: 'pending' }];
+function getInvitesByIdQueryKey({ inviteId }) {
+    return [shared_js_1.ROOT_QUERY_KEY, 'invites', { inviteId }];
 }
-function pendingInvitesQueryOptions({ clientApi, }) {
+function getInvitesQueryOptions({ clientApi, }) {
     return (0, react_query_1.queryOptions)({
         ...(0, shared_js_1.baseQueryOptions)(),
-        queryKey: getPendingInvitesQueryKey(),
+        queryKey: getInvitesQueryKey(),
         queryFn: async () => {
-            return clientApi.invite.getPending();
+            return clientApi.invite.getMany();
+        },
+    });
+}
+function getInviteByIdQueryOptions({ clientApi, inviteId, }) {
+    return (0, react_query_1.queryOptions)({
+        ...(0, shared_js_1.baseQueryOptions)(),
+        queryKey: getInvitesByIdQueryKey({ inviteId }),
+        queryFn: async () => {
+            return clientApi.invite.getById(inviteId);
         },
     });
 }

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

@@ -37,7 +37,7 @@ export declare function useClientApi(): import("@comapeo/ipc/dist/client.js").Ma
 export declare function useOwnDeviceInfo(): {
     data: {
         deviceId: string;
-        deviceType: "device_type_unspecified" | "mobile" | "tablet" | "desktop" | "selfHostedServer" | "UNRECOGNIZED";
+        deviceType: "UNRECOGNIZED" | "device_type_unspecified" | "mobile" | "tablet" | "desktop" | "selfHostedServer";
     } & Partial<import("@comapeo/core/dist/schema/client.js").DeviceInfoParam>;
     error: Error | null;
     isRefetching: boolean;
@@ -66,6 +66,10 @@ export declare function useSetOwnDeviceInfo(): {
         name: string;
         deviceType: import("@comapeo/schema").DeviceInfo["deviceType"];
     }, unknown>;
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, {
+        name: string;
+        deviceType: import("@comapeo/schema").DeviceInfo["deviceType"];
+    }, unknown>;
     reset: () => void;
     status: "error";
 } | {
@@ -74,6 +78,10 @@ export declare function useSetOwnDeviceInfo(): {
         name: string;
         deviceType: import("@comapeo/schema").DeviceInfo["deviceType"];
     }, unknown>;
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, {
+        name: string;
+        deviceType: import("@comapeo/schema").DeviceInfo["deviceType"];
+    }, unknown>;
     reset: () => void;
     status: "pending" | "success" | "idle";
 };
@@ -85,6 +93,9 @@ export declare function useSetIsArchiveDevice(): {
     mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
         isArchiveDevice: boolean;
     }, unknown>;
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, {
+        isArchiveDevice: boolean;
+    }, unknown>;
     reset: () => void;
     status: "error";
 } | {
@@ -92,6 +103,9 @@ export declare function useSetIsArchiveDevice(): {
     mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
         isArchiveDevice: boolean;
     }, unknown>;
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, {
+        isArchiveDevice: boolean;
+    }, unknown>;
     reset: () => void;
     status: "pending" | "success" | "idle";
 };

package/dist/esm/hooks/client.js

@@ -70,10 +70,10 @@ export function useIsArchiveDevice() {
 export function useSetOwnDeviceInfo() {
     const queryClient = useQueryClient();
     const clientApi = useClientApi();
-    const { error, mutate, reset, status } = useMutation(setOwnDeviceInfoMutationOptions({ clientApi, queryClient }));
+    const { error, mutate, mutateAsync, reset, status } = useMutation(setOwnDeviceInfoMutationOptions({ clientApi, queryClient }));
     return status === 'error'
-        ? { error, mutate, reset, status }
-        : { error: null, mutate, reset, status };
+        ? { error, mutate, mutateAsync, reset, status }
+        : { error: null, mutate, mutateAsync, reset, status };
 }
 /**
  * Set or unset the current device as an archive device.
@@ -81,8 +81,8 @@ export function useSetOwnDeviceInfo() {
 export function useSetIsArchiveDevice() {
     const queryClient = useQueryClient();
     const clientApi = useClientApi();
-    const { error, mutate, status, reset } = useMutation(setIsArchiveDeviceMutationOptions({ clientApi, queryClient }));
+    const { error, mutate, mutateAsync, status, reset } = useMutation(setIsArchiveDeviceMutationOptions({ clientApi, queryClient }));
     return status === 'error'
-        ? { error, mutate, reset, status }
-        : { error: null, mutate, reset, status };
+        ? { error, mutate, mutateAsync, reset, status }
+        : { error: null, mutate, mutateAsync, reset, status };
 }

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

@@ -125,6 +125,11 @@ export declare function useCreateDocument<D extends WriteableDocumentType>({ doc
     }, Error, {
         value: Omit<import("../lib/types.js").WriteableValue<D>, "schemaName">;
     }, unknown>;
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<import("../lib/types.js").WriteableDocument<D> & {
+        forks: Array<string>;
+    }, Error, {
+        value: Omit<import("../lib/types.js").WriteableValue<D>, "schemaName">;
+    }, unknown>;
     reset: () => void;
     status: "error";
 } | {
@@ -134,6 +139,11 @@ export declare function useCreateDocument<D extends WriteableDocumentType>({ doc
     }, Error, {
         value: Omit<import("../lib/types.js").WriteableValue<D>, "schemaName">;
     }, unknown>;
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<import("../lib/types.js").WriteableDocument<D> & {
+        forks: Array<string>;
+    }, Error, {
+        value: Omit<import("../lib/types.js").WriteableValue<D>, "schemaName">;
+    }, unknown>;
     reset: () => void;
     status: "pending" | "success" | "idle";
 };
@@ -154,6 +164,12 @@ export declare function useUpdateDocument<D extends WriteableDocumentType>({ doc
         versionId: string;
         value: Omit<import("../lib/types.js").WriteableValue<D>, "schemaName">;
     }, unknown>;
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<import("../lib/types.js").WriteableDocument<D> & {
+        forks: Array<string>;
+    }, Error, {
+        versionId: string;
+        value: Omit<import("../lib/types.js").WriteableValue<D>, "schemaName">;
+    }, unknown>;
     reset: () => void;
     status: "error";
 } | {
@@ -164,6 +180,12 @@ export declare function useUpdateDocument<D extends WriteableDocumentType>({ doc
         versionId: string;
         value: Omit<import("../lib/types.js").WriteableValue<D>, "schemaName">;
     }, unknown>;
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<import("../lib/types.js").WriteableDocument<D> & {
+        forks: Array<string>;
+    }, Error, {
+        versionId: string;
+        value: Omit<import("../lib/types.js").WriteableValue<D>, "schemaName">;
+    }, unknown>;
     reset: () => void;
     status: "pending" | "success" | "idle";
 };
@@ -183,6 +205,11 @@ export declare function useDeleteDocument<D extends WriteableDocumentType>({ doc
     }, Error, {
         docId: string;
     }, unknown>;
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<import("../lib/types.js").WriteableDocument<D> & {
+        forks: Array<string>;
+    }, Error, {
+        docId: string;
+    }, unknown>;
     reset: () => void;
     status: "error";
 } | {
@@ -192,6 +219,11 @@ export declare function useDeleteDocument<D extends WriteableDocumentType>({ doc
     }, Error, {
         docId: string;
     }, unknown>;
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<import("../lib/types.js").WriteableDocument<D> & {
+        forks: Array<string>;
+    }, Error, {
+        docId: string;
+    }, unknown>;
     reset: () => void;
     status: "pending" | "success" | "idle";
 };

package/dist/esm/hooks/documents.js

@@ -140,15 +140,15 @@ export function useManyDocs({ projectId, docType, includeDeleted, lang, }) {
 export function useCreateDocument({ docType, projectId, }) {
     const queryClient = useQueryClient();
     const { data: projectApi } = useSingleProject({ projectId });
-    const { error, mutate, reset, status } = useMutation(createDocumentMutationOptions({
+    const { error, mutate, mutateAsync, reset, status } = useMutation(createDocumentMutationOptions({
         docType,
         projectApi,
         projectId,
         queryClient,
     }));
     return status === 'error'
-        ? { error, mutate, reset, status }
-        : { error: null, mutate, reset, status };
+        ? { error, mutate, mutateAsync, reset, status }
+        : { error: null, mutate, mutateAsync, reset, status };
 }
 /**
  * Update a document within a project.
@@ -159,15 +159,15 @@ export function useCreateDocument({ docType, projectId, }) {
 export function useUpdateDocument({ docType, projectId, }) {
     const queryClient = useQueryClient();
     const { data: projectApi } = useSingleProject({ projectId });
-    const { error, mutate, reset, status } = useMutation(updateDocumentMutationOptions({
+    const { error, mutate, mutateAsync, reset, status } = useMutation(updateDocumentMutationOptions({
         docType,
         projectApi,
         projectId,
         queryClient,
     }));
     return status === 'error'
-        ? { error, mutate, reset, status }
-        : { error: null, mutate, reset, status };
+        ? { error, mutate, mutateAsync, reset, status }
+        : { error: null, mutate, mutateAsync, reset, status };
 }
 /**
  * Delete a document within a project.
@@ -178,13 +178,13 @@ export function useUpdateDocument({ docType, projectId, }) {
 export function useDeleteDocument({ docType, projectId, }) {
     const queryClient = useQueryClient();
     const { data: projectApi } = useSingleProject({ projectId });
-    const { error, mutate, reset, status } = useMutation(deleteDocumentMutationOptions({
+    const { error, mutate, mutateAsync, reset, status } = useMutation(deleteDocumentMutationOptions({
         docType,
         projectApi,
         projectId,
         queryClient,
     }));
     return status === 'error'
-        ? { error, mutate, reset, status }
-        : { error: null, mutate, reset, status };
+        ? { error, mutate, mutateAsync, reset, status }
+        : { error: null, mutate, mutateAsync, reset, status };
 }

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

@@ -1,3 +1,53 @@
+/**
+ * Set up listeners for received and updated invites.
+ * It is necessary to use this if you want the invites-related read hooks to update
+ * based on invites that are received or changed in the background.
+ *
+ * @example
+ * ```tsx
+ * function App() {
+ *   // Use this somewhere near the root of the application
+ *   useSetUpInvitesListeners()
+ *
+ *   return <RestOfApp />
+ * }
+ * ```
+ */
+export declare function useSetUpInvitesListeners(): void;
+/**
+ * Get all invites that the device has received.
+ *
+ * @example
+ * ```ts
+ * function Example() {
+ *   const { data } = useManyInvites()
+ * }
+ * ```
+ */
+export declare function useManyInvites(): {
+    data: import("@comapeo/core/dist/invite/invite-api.js").Invite[];
+    error: Error | null;
+    isRefetching: boolean;
+};
+/**
+ * Get a single invite based on its ID.
+ *
+ * @param opts.inviteId ID of invite
+ *
+ * @example
+ * ```ts
+ * function Example() {
+ *   const { data } = useSingleInvite({ inviteId: '...' })
+ * }
+ * ```
+ */
+export declare function useSingleInvite({ inviteId }: {
+    inviteId: string;
+}): {
+    data: import("@comapeo/core/dist/invite/invite-api.js").Invite;
+    error: Error | null;
+    isRefetching: boolean;
+};
 /**
  * Accept an invite that has been received.
  */
@@ -6,6 +56,9 @@ export declare function useAcceptInvite(): {
     mutate: import("@tanstack/react-query").UseMutateFunction<string, Error, {
         inviteId: string;
     }, unknown>;
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<string, Error, {
+        inviteId: string;
+    }, unknown>;
     reset: () => void;
     status: "error";
 } | {
@@ -13,6 +66,9 @@ export declare function useAcceptInvite(): {
     mutate: import("@tanstack/react-query").UseMutateFunction<string, Error, {
         inviteId: string;
     }, unknown>;
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<string, Error, {
+        inviteId: string;
+    }, unknown>;
     reset: () => void;
     status: "pending" | "success" | "idle";
 };
@@ -24,6 +80,9 @@ export declare function useRejectInvite(): {
     mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
         inviteId: string;
     }, unknown>;
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, {
+        inviteId: string;
+    }, unknown>;
     reset: () => void;
     status: "error";
 } | {
@@ -31,6 +90,9 @@ export declare function useRejectInvite(): {
     mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
         inviteId: string;
     }, unknown>;
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, {
+        inviteId: string;
+    }, unknown>;
     reset: () => void;
     status: "pending" | "success" | "idle";
 };
@@ -49,6 +111,12 @@ export declare function useSendInvite({ projectId }: {
         roleId: import("@comapeo/core/dist/roles.js").RoleIdForNewInvite;
         roleName?: string;
     }, unknown>;
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<"ACCEPT" | "REJECT" | "ALREADY", Error, {
+        deviceId: string;
+        roleDescription?: string;
+        roleId: import("@comapeo/core/dist/roles.js").RoleIdForNewInvite;
+        roleName?: string;
+    }, unknown>;
     reset: () => void;
     status: "error";
 } | {
@@ -59,6 +127,12 @@ export declare function useSendInvite({ projectId }: {
         roleId: import("@comapeo/core/dist/roles.js").RoleIdForNewInvite;
         roleName?: string;
     }, unknown>;
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<"ACCEPT" | "REJECT" | "ALREADY", Error, {
+        deviceId: string;
+        roleDescription?: string;
+        roleId: import("@comapeo/core/dist/roles.js").RoleIdForNewInvite;
+        roleName?: string;
+    }, unknown>;
     reset: () => void;
     status: "pending" | "success" | "idle";
 };
@@ -74,6 +148,9 @@ export declare function useRequestCancelInvite({ projectId }: {
     mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
         deviceId: string;
     }, unknown>;
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, {
+        deviceId: string;
+    }, unknown>;
     reset: () => void;
     status: "error";
 } | {
@@ -81,6 +158,9 @@ export declare function useRequestCancelInvite({ projectId }: {
     mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
         deviceId: string;
     }, unknown>;
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, {
+        deviceId: string;
+    }, unknown>;
     reset: () => void;
     status: "pending" | "success" | "idle";
 };