@comapeo/core-react 3.3.0 → 4.0.0

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

@@ -37,7 +37,7 @@ export declare function useClientApi(): import("@comapeo/ipc/dist/client.js", {
 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", { with: { "resolution-mode": "import" } }).DeviceInfoParam>;
     error: Error | null;
     isRefetching: boolean;

package/dist/commonjs/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", { with: { "resolution-mode": "import" } }).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", { with: { "resolution-mode": "import" } }).Invite;
+    error: Error | null;
+    isRefetching: boolean;
+};
 /**
  * Accept an invite that has been received.
  */

package/dist/commonjs/hooks/invites.js

@@ -1,13 +1,79 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.useSetUpInvitesListeners = useSetUpInvitesListeners;
+exports.useManyInvites = useManyInvites;
+exports.useSingleInvite = useSingleInvite;
 exports.useAcceptInvite = useAcceptInvite;
 exports.useRejectInvite = useRejectInvite;
 exports.useSendInvite = useSendInvite;
 exports.useRequestCancelInvite = useRequestCancelInvite;
 const react_query_1 = require("@tanstack/react-query");
+const react_1 = require("react");
 const invites_js_1 = require("../lib/react-query/invites.js");
 const client_js_1 = require("./client.js");
 const projects_js_1 = require("./projects.js");
+/**
+ * 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 />
+ * }
+ * ```
+ */
+function useSetUpInvitesListeners() {
+    const queryClient = (0, react_query_1.useQueryClient)();
+    const clientApi = (0, client_js_1.useClientApi)();
+    (0, react_1.useEffect)(() => {
+        function invalidateCache() {
+            queryClient.invalidateQueries({ queryKey: (0, invites_js_1.getInvitesQueryKey)() });
+        }
+        clientApi.invite.addListener('invite-received', invalidateCache);
+        clientApi.invite.addListener('invite-updated', invalidateCache);
+        return () => {
+            clientApi.invite.removeListener('invite-received', invalidateCache);
+            clientApi.invite.removeListener('invite-updated', invalidateCache);
+        };
+    }, [clientApi, queryClient]);
+}
+/**
+ * Get all invites that the device has received.
+ *
+ * @example
+ * ```ts
+ * function Example() {
+ *   const { data } = useManyInvites()
+ * }
+ * ```
+ */
+function useManyInvites() {
+    const clientApi = (0, client_js_1.useClientApi)();
+    const { data, error, isRefetching } = (0, react_query_1.useSuspenseQuery)((0, invites_js_1.getInvitesQueryOptions)({ clientApi }));
+    return { data, error, isRefetching };
+}
+/**
+ * Get a single invite based on its ID.
+ *
+ * @param opts.inviteId ID of invite
+ *
+ * @example
+ * ```ts
+ * function Example() {
+ *   const { data } = useSingleInvite({ inviteId: '...' })
+ * }
+ * ```
+ */
+function useSingleInvite({ inviteId }) {
+    const clientApi = (0, client_js_1.useClientApi)();
+    const { data, error, isRefetching } = (0, react_query_1.useSuspenseQuery)((0, invites_js_1.getInviteByIdQueryOptions)({ clientApi, inviteId }));
+    return { data, error, isRefetching };
+}
 /**
  * Accept an invite that has been received.
  */

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;

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.
  */

package/dist/esm/hooks/invites.js

@@ -1,7 +1,70 @@
-import { useMutation, useQueryClient } from '@tanstack/react-query';
-import { acceptInviteMutationOptions, rejectInviteMutationOptions, requestCancelInviteMutationOptions, sendInviteMutationOptions, } from '../lib/react-query/invites.js';
+import { useMutation, useQueryClient, useSuspenseQuery, } from '@tanstack/react-query';
+import { useEffect } from 'react';
+import { acceptInviteMutationOptions, getInviteByIdQueryOptions, getInvitesQueryKey, getInvitesQueryOptions, rejectInviteMutationOptions, requestCancelInviteMutationOptions, sendInviteMutationOptions, } from '../lib/react-query/invites.js';
 import { useClientApi } from './client.js';
 import { useSingleProject } from './projects.js';
+/**
+ * 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 function useSetUpInvitesListeners() {
+    const queryClient = useQueryClient();
+    const clientApi = useClientApi();
+    useEffect(() => {
+        function invalidateCache() {
+            queryClient.invalidateQueries({ queryKey: getInvitesQueryKey() });
+        }
+        clientApi.invite.addListener('invite-received', invalidateCache);
+        clientApi.invite.addListener('invite-updated', invalidateCache);
+        return () => {
+            clientApi.invite.removeListener('invite-received', invalidateCache);
+            clientApi.invite.removeListener('invite-updated', invalidateCache);
+        };
+    }, [clientApi, queryClient]);
+}
+/**
+ * Get all invites that the device has received.
+ *
+ * @example
+ * ```ts
+ * function Example() {
+ *   const { data } = useManyInvites()
+ * }
+ * ```
+ */
+export function useManyInvites() {
+    const clientApi = useClientApi();
+    const { data, error, isRefetching } = useSuspenseQuery(getInvitesQueryOptions({ clientApi }));
+    return { data, error, isRefetching };
+}
+/**
+ * Get a single invite based on its ID.
+ *
+ * @param opts.inviteId ID of invite
+ *
+ * @example
+ * ```ts
+ * function Example() {
+ *   const { data } = useSingleInvite({ inviteId: '...' })
+ * }
+ * ```
+ */
+export function useSingleInvite({ inviteId }) {
+    const clientApi = useClientApi();
+    const { data, error, isRefetching } = useSuspenseQuery(getInviteByIdQueryOptions({ clientApi, inviteId }));
+    return { data, error, isRefetching };
+}
 /**
  * Accept an invite that has been received.
  */

package/dist/esm/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/esm/index.js

@@ -1,6 +1,6 @@
 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';

package/dist/esm/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").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").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").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").DeviceInfoParam>;
         [dataTagErrorSymbol]: Error;
     };

package/dist/esm/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").MapBuffers<import("@comapeo/core/dist/invite-api.js").InviteInternal>[], Error, import("@comapeo/core/dist/types.js").MapBuffers<import("@comapeo/core/dist/invite-api.js").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").Invite[], Error, import("@comapeo/core/dist/invite/invite-api.js").Invite[], readonly ["@comapeo/core-react", "invites"]>, "queryFn"> & {
+    queryFn?: import("@tanstack/react-query").QueryFunction<import("@comapeo/core/dist/invite/invite-api.js").Invite[], readonly ["@comapeo/core-react", "invites"], never> | undefined;
+} & {
+    queryKey: readonly ["@comapeo/core-react", "invites"] & {
+        [dataTagSymbol]: import("@comapeo/core/dist/invite/invite-api.js").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").Invite, Error, import("@comapeo/core/dist/invite/invite-api.js").Invite, readonly ["@comapeo/core-react", "invites", {
+    readonly inviteId: string;
 }]>, "queryFn"> & {
-    queryFn?: import("@tanstack/react-query").QueryFunction<import("@comapeo/core/dist/types.js").MapBuffers<import("@comapeo/core/dist/invite-api.js").InviteInternal>[], readonly ["@comapeo/core-react", "invites", {
-        readonly status: "pending";
+    queryFn?: import("@tanstack/react-query").QueryFunction<import("@comapeo/core/dist/invite/invite-api.js").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").MapBuffers<import("@comapeo/core/dist/invite-api.js").InviteInternal>[];
+        [dataTagSymbol]: import("@comapeo/core/dist/invite/invite-api.js").Invite;
         [dataTagErrorSymbol]: Error;
     };
 };

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

@@ -4,15 +4,24 @@ import { baseMutationOptions, baseQueryOptions, ROOT_QUERY_KEY, } from './shared
 export function getInvitesQueryKey() {
     return [ROOT_QUERY_KEY, 'invites'];
 }
-export function getPendingInvitesQueryKey() {
-    return [ROOT_QUERY_KEY, 'invites', { status: 'pending' }];
+export function getInvitesByIdQueryKey({ inviteId }) {
+    return [ROOT_QUERY_KEY, 'invites', { inviteId }];
 }
-export function pendingInvitesQueryOptions({ clientApi, }) {
+export function getInvitesQueryOptions({ clientApi, }) {
     return queryOptions({
         ...baseQueryOptions(),
-        queryKey: getPendingInvitesQueryKey(),
+        queryKey: getInvitesQueryKey(),
         queryFn: async () => {
-            return clientApi.invite.getPending();
+            return clientApi.invite.getMany();
+        },
+    });
+}
+export function getInviteByIdQueryOptions({ clientApi, inviteId, }) {
+    return queryOptions({
+        ...baseQueryOptions(),
+        queryKey: getInvitesByIdQueryKey({ inviteId }),
+        queryFn: async () => {
+            return clientApi.invite.getById(inviteId);
         },
     });
 }

package/docs/API.md

@@ -31,6 +31,9 @@
 - [useCreateDocument](#usecreatedocument)
 - [useUpdateDocument](#useupdatedocument)
 - [useDeleteDocument](#usedeletedocument)
+- [useSetUpInvitesListeners](#usesetupinviteslisteners)
+- [useManyInvites](#usemanyinvites)
+- [useSingleInvite](#usesingleinvite)
 - [useAcceptInvite](#useacceptinvite)
 - [useRejectInvite](#userejectinvite)
 - [useSendInvite](#usesendinvite)
@@ -86,7 +89,7 @@ Retrieve info about the current device.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useOwnDeviceInfo` | `() => { data: { deviceId: string; deviceType: "device_type_unspecified" or "mobile" or "tablet" or "desktop" or "selfHostedServer" or "UNRECOGNIZED"; } and Partial<DeviceInfoParam>; error: Error or null; isRefetching: boolean; }` |
+| `useOwnDeviceInfo` | `() => { data: { deviceId: string; deviceType: "UNRECOGNIZED" or "device_type_unspecified" or "mobile" or "tablet" or "desktop" or "selfHostedServer"; } and Partial<DeviceInfoParam>; error: Error or null; isRefetching: boolean; }` |
 
 Examples:
 
@@ -120,7 +123,7 @@ Update the device info for the current device.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useSetOwnDeviceInfo` | `() => { error: Error; mutate: UseMutateFunction<void, Error, { name: string; deviceType: "device_type_unspecified" or "mobile" or "tablet" or "desktop" or "selfHostedServer" or "UNRECOGNIZED"; }, unknown>; reset: () => void; status: "error"; } or { ...; }` |
+| `useSetOwnDeviceInfo` | `() => { error: Error; mutate: UseMutateFunction<void, Error, { name: string; deviceType: "UNRECOGNIZED" or "device_type_unspecified" or "mobile" or "tablet" or "desktop" or "selfHostedServer"; }, unknown>; mutateAsync: UseMutateAsyncFunction<...>; reset: () => void; status: "error"; } or { ...; }` |
 
 ### useSetIsArchiveDevice
 
@@ -128,7 +131,7 @@ Set or unset the current device as an archive device.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useSetIsArchiveDevice` | `() => { error: Error; mutate: UseMutateFunction<void, Error, { isArchiveDevice: boolean; }, unknown>; reset: () => void; status: "error"; } or { error: null; mutate: UseMutateFunction<...>; reset: () => void; status: "pending" or ... 1 more ... or "idle"; }` |
+| `useSetIsArchiveDevice` | `() => { error: Error; mutate: UseMutateFunction<void, Error, { isArchiveDevice: boolean; }, unknown>; mutateAsync: UseMutateAsyncFunction<void, Error, { isArchiveDevice: boolean; }, unknown>; reset: () => void; status: "error"; } or { ...; }` |
 
 ### useProjectSettings
 
@@ -407,7 +410,7 @@ function BasicExample() {
 
 | Function | Type |
 | ---------- | ---------- |
-| `useAddServerPeer` | `({ projectId }: { projectId: string; }) => { error: Error; mutate: UseMutateFunction<void, Error, { baseUrl: string; dangerouslyAllowInsecureConnections?: boolean or undefined; }, unknown>; reset: () => void; status: "error"; } or { ...; }` |
+| `useAddServerPeer` | `({ projectId }: { projectId: string; }) => { error: Error; mutate: UseMutateFunction<void, Error, { baseUrl: string; dangerouslyAllowInsecureConnections?: boolean or undefined; }, unknown>; mutateAsync: UseMutateAsyncFunction<...>; reset: () => void; status: "error"; } or { ...; }` |
 
 ### useCreateProject
 
@@ -415,7 +418,7 @@ Create a new project.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useCreateProject` | `() => { error: Error; mutate: UseMutateFunction<string, Error, { name?: string or undefined; configPath?: string or undefined; } or undefined, unknown>; reset: () => void; status: "error"; } or { ...; }` |
+| `useCreateProject` | `() => { error: Error; mutate: UseMutateFunction<string, Error, { name?: string or undefined; configPath?: string or undefined; } or undefined, unknown>; mutateAsync: UseMutateAsyncFunction<...>; reset: () => void; status: "error"; } or { ...; }` |
 
 ### useLeaveProject
 
@@ -423,7 +426,7 @@ Leave an existing project.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useLeaveProject` | `() => { error: Error; mutate: UseMutateFunction<void, Error, { projectId: string; }, unknown>; reset: () => void; status: "error"; } or { error: null; mutate: UseMutateFunction<void, Error, { ...; }, unknown>; reset: () => void; status: "pending" or ... 1 more ... or "idle"; }` |
+| `useLeaveProject` | `() => { error: Error; mutate: UseMutateFunction<void, Error, { projectId: string; }, unknown>; mutateAsync: UseMutateAsyncFunction<void, Error, { projectId: string; }, unknown>; reset: () => void; status: "error"; } or { ...; }` |
 
 ### useImportProjectConfig
 
@@ -431,7 +434,7 @@ Update the configuration of a project using an external file.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useImportProjectConfig` | `({ projectId }: { projectId: string; }) => { error: Error; mutate: UseMutateFunction<Error[], Error, { configPath: string; }, unknown>; reset: () => void; status: "error"; } or { ...; }` |
+| `useImportProjectConfig` | `({ projectId }: { projectId: string; }) => { error: Error; mutate: UseMutateFunction<Error[], Error, { configPath: string; }, unknown>; mutateAsync: UseMutateAsyncFunction<Error[], Error, { ...; }, unknown>; reset: () => void; status: "error"; } or { ...; }` |
 
 Parameters:
 
@@ -444,7 +447,7 @@ Update the settings of a project.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useUpdateProjectSettings` | `({ projectId }: { projectId: string; }) => { error: Error; mutate: UseMutateFunction<EditableProjectSettings, Error, { name?: string or undefined; configMetadata?: { ...; } or undefined; defaultPresets?: { ...; } or undefined; }, unknown>; reset: () => void; status: "error"; } or { ...; }` |
+| `useUpdateProjectSettings` | `({ projectId }: { projectId: string; }) => { error: Error; mutate: UseMutateFunction<EditableProjectSettings, Error, { name?: string or undefined; configMetadata?: { ...; } or undefined; defaultPresets?: { ...; } or undefined; }, unknown>; mutateAsync: UseMutateAsyncFunction<...>; reset: () => void; status: "error"; } ...` |
 
 Parameters:
 
@@ -457,7 +460,7 @@ Create a blob for a project.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useCreateBlob` | `({ projectId }: { projectId: string; }) => { error: Error; mutate: UseMutateFunction<{ driveId: string; name: string; type: "photo" or "audio" or "video"; hash: string; }, Error, { original: string; preview?: string or undefined; thumbnail?: string or undefined; metadata: Metadata; }, unknown>; reset: () => void; status...` |
+| `useCreateBlob` | `({ projectId }: { projectId: string; }) => { error: Error; mutate: UseMutateFunction<{ driveId: string; name: string; type: "photo" or "audio" or "video"; hash: string; }, Error, { original: string; preview?: string or undefined; thumbnail?: string or undefined; metadata: Metadata; }, unknown>; mutateAsync: UseMutateAsy...` |
 
 Parameters:
 
@@ -508,13 +511,13 @@ Provides the progress of data sync for sync-enabled connected peers
 
 | Function | Type |
 | ---------- | ---------- |
-| `useStartSync` | `({ projectId }: { projectId: string; }) => { error: Error; mutate: UseMutateFunction<void, Error, { autostopDataSyncAfter: number or null; } or undefined, unknown>; reset: () => void; status: "error"; } or { ...; }` |
+| `useStartSync` | `({ projectId }: { projectId: string; }) => { error: Error; mutate: UseMutateFunction<void, Error, { autostopDataSyncAfter: number or null; } or undefined, unknown>; mutateAsync: UseMutateAsyncFunction<...>; reset: () => void; status: "error"; } or { ...; }` |
 
 ### useStopSync
 
 | Function | Type |
 | ---------- | ---------- |
-| `useStopSync` | `({ projectId }: { projectId: string; }) => { error: Error; mutate: UseMutateFunction<void, Error, void, unknown>; reset: () => void; status: "error"; } or { error: null; mutate: UseMutateFunction<...>; reset: () => void; status: "pending" or ... 1 more ... or "idle"; }` |
+| `useStopSync` | `({ projectId }: { projectId: string; }) => { error: Error; mutate: UseMutateFunction<void, Error, void, unknown>; mutateAsync: UseMutateAsyncFunction<void, Error, void, unknown>; reset: () => void; status: "error"; } or { ...; }` |
 
 ### useSingleDocByDocId
 
@@ -524,7 +527,7 @@ Triggers the closest error boundary if the document cannot be found
 
 | Function | Type |
 | ---------- | ---------- |
-| `useSingleDocByDocId` | `<D extends WriteableDocumentType>({ projectId, docType, docId, lang, }: { projectId: string; docType: D; docId: string; lang?: string or undefined; }) => ReadHookResult<Extract<{ schemaName: "deviceInfo"; name: string; deviceType: "device_type_unspecified" or ... 4 more ... or "UNRECOGNIZED"; ... 7 more ...; deleted: b...` |
+| `useSingleDocByDocId` | `<D extends WriteableDocumentType>({ projectId, docType, docId, lang, }: { projectId: string; docType: D; docId: string; lang?: string or undefined; }) => ReadHookResult<Extract<{ schemaName: "deviceInfo"; name: string; deviceType: "UNRECOGNIZED" or ... 4 more ... or "selfHostedServer"; ... 7 more ...; deleted: boolean;...` |
 
 Parameters:
 
@@ -557,7 +560,7 @@ Triggers the closest error boundary if the document cannot be found.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useSingleDocByVersionId` | `<D extends WriteableDocumentType>({ projectId, docType, versionId, lang, }: { projectId: string; docType: D; versionId: string; lang?: string or undefined; }) => ReadHookResult<Extract<{ schemaName: "deviceInfo"; name: string; deviceType: "device_type_unspecified" or ... 4 more ... or "UNRECOGNIZED"; ... 7 more ...; de...` |
+| `useSingleDocByVersionId` | `<D extends WriteableDocumentType>({ projectId, docType, versionId, lang, }: { projectId: string; docType: D; versionId: string; lang?: string or undefined; }) => ReadHookResult<Extract<{ schemaName: "deviceInfo"; name: string; deviceType: "UNRECOGNIZED" or ... 4 more ... or "selfHostedServer"; ... 7 more ...; deleted: ...` |
 
 Parameters:
 
@@ -590,7 +593,7 @@ Retrieve all documents of a specific `docType`.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useManyDocs` | `<D extends WriteableDocumentType>({ projectId, docType, includeDeleted, lang, }: { projectId: string; docType: D; includeDeleted?: boolean or undefined; lang?: string or undefined; }) => ReadHookResult<(Extract<{ schemaName: "deviceInfo"; name: string; deviceType: "device_type_unspecified" or ... 4 more ... or "UNRECOGN...` |
+| `useManyDocs` | `<D extends WriteableDocumentType>({ projectId, docType, includeDeleted, lang, }: { projectId: string; docType: D; includeDeleted?: boolean or undefined; lang?: string or undefined; }) => ReadHookResult<(Extract<{ schemaName: "deviceInfo"; name: string; deviceType: "UNRECOGNIZED" or ... 4 more ... or "selfHostedServer"; ...` |
 
 Parameters:
 
@@ -634,7 +637,7 @@ Create a document for a project.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useCreateDocument` | `<D extends WriteableDocumentType>({ docType, projectId, }: { docType: D; projectId: string; }) => { error: Error; mutate: UseMutateFunction<WriteableDocument<D> and { forks: string[]; }, Error, { ...; }, unknown>; reset: () => void; status: "error"; } or { ...; }` |
+| `useCreateDocument` | `<D extends WriteableDocumentType>({ docType, projectId, }: { docType: D; projectId: string; }) => { error: Error; mutate: UseMutateFunction<WriteableDocument<D> and { forks: string[]; }, Error, { ...; }, unknown>; mutateAsync: UseMutateAsyncFunction<...>; reset: () => void; status: "error"; } or { ...; }` |
 
 Parameters:
 
@@ -648,7 +651,7 @@ Update a document within a project.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useUpdateDocument` | `<D extends WriteableDocumentType>({ docType, projectId, }: { docType: D; projectId: string; }) => { error: Error; mutate: UseMutateFunction<WriteableDocument<D> and { forks: string[]; }, Error, { ...; }, unknown>; reset: () => void; status: "error"; } or { ...; }` |
+| `useUpdateDocument` | `<D extends WriteableDocumentType>({ docType, projectId, }: { docType: D; projectId: string; }) => { error: Error; mutate: UseMutateFunction<WriteableDocument<D> and { forks: string[]; }, Error, { ...; }, unknown>; mutateAsync: UseMutateAsyncFunction<...>; reset: () => void; status: "error"; } or { ...; }` |
 
 Parameters:
 
@@ -662,7 +665,7 @@ Delete a document within a project.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useDeleteDocument` | `<D extends WriteableDocumentType>({ docType, projectId, }: { docType: D; projectId: string; }) => { error: Error; mutate: UseMutateFunction<WriteableDocument<D> and { forks: string[]; }, Error, { ...; }, unknown>; reset: () => void; status: "error"; } or { ...; }` |
+| `useDeleteDocument` | `<D extends WriteableDocumentType>({ docType, projectId, }: { docType: D; projectId: string; }) => { error: Error; mutate: UseMutateFunction<WriteableDocument<D> and { forks: string[]; }, Error, { ...; }, unknown>; mutateAsync: UseMutateAsyncFunction<...>; reset: () => void; status: "error"; } or { ...; }` |
 
 Parameters:
 
@@ -670,13 +673,74 @@ Parameters:
 * `opts.projectId`: Public ID of project document belongs to.
 
 
+### useSetUpInvitesListeners
+
+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.
+
+| Function | Type |
+| ---------- | ---------- |
+| `useSetUpInvitesListeners` | `() => void` |
+
+Examples:
+
+```tsx
+function App() {
+  // Use this somewhere near the root of the application
+  useSetUpInvitesListeners()
+
+  return <RestOfApp />
+}
+```
+
+
+### useManyInvites
+
+Get all invites that the device has received.
+
+| Function | Type |
+| ---------- | ---------- |
+| `useManyInvites` | `() => { data: Invite[]; error: Error or null; isRefetching: boolean; }` |
+
+Examples:
+
+```ts
+function Example() {
+  const { data } = useManyInvites()
+}
+```
+
+
+### useSingleInvite
+
+Get a single invite based on its ID.
+
+| Function | Type |
+| ---------- | ---------- |
+| `useSingleInvite` | `({ inviteId }: { inviteId: string; }) => { data: Invite; error: Error or null; isRefetching: boolean; }` |
+
+Parameters:
+
+* `opts.inviteId`: ID of invite
+
+
+Examples:
+
+```ts
+function Example() {
+  const { data } = useSingleInvite({ inviteId: '...' })
+}
+```
+
+
 ### useAcceptInvite
 
 Accept an invite that has been received.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useAcceptInvite` | `() => { error: Error; mutate: UseMutateFunction<string, Error, { inviteId: string; }, unknown>; reset: () => void; status: "error"; } or { error: null; mutate: UseMutateFunction<string, Error, { ...; }, unknown>; reset: () => void; status: "pending" or ... 1 more ... or "idle"; }` |
+| `useAcceptInvite` | `() => { error: Error; mutate: UseMutateFunction<string, Error, { inviteId: string; }, unknown>; mutateAsync: UseMutateAsyncFunction<string, Error, { inviteId: string; }, unknown>; reset: () => void; status: "error"; } or { ...; }` |
 
 ### useRejectInvite
 
@@ -684,7 +748,7 @@ Reject an invite that has been received.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useRejectInvite` | `() => { error: Error; mutate: UseMutateFunction<void, Error, { inviteId: string; }, unknown>; reset: () => void; status: "error"; } or { error: null; mutate: UseMutateFunction<void, Error, { ...; }, unknown>; reset: () => void; status: "pending" or ... 1 more ... or "idle"; }` |
+| `useRejectInvite` | `() => { error: Error; mutate: UseMutateFunction<void, Error, { inviteId: string; }, unknown>; mutateAsync: UseMutateAsyncFunction<void, Error, { inviteId: string; }, unknown>; reset: () => void; status: "error"; } or { ...; }` |
 
 ### useSendInvite
 
@@ -692,7 +756,7 @@ Send an invite for a project.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useSendInvite` | `({ projectId }: { projectId: string; }) => { error: Error; mutate: UseMutateFunction<"ACCEPT" or "REJECT" or "ALREADY", Error, { deviceId: string; roleDescription?: string or undefined; roleId: "f7c150f5a3a9a855" or "012fd2d431c0bf60" or "9e6d29263cba36c9"; roleName?: string or undefined; }, unknown>; reset: () => void; s...` |
+| `useSendInvite` | `({ projectId }: { projectId: string; }) => { error: Error; mutate: UseMutateFunction<"ACCEPT" or "REJECT" or "ALREADY", Error, { deviceId: string; roleDescription?: string or undefined; roleId: "f7c150f5a3a9a855" or "012fd2d431c0bf60" or "9e6d29263cba36c9"; roleName?: string or undefined; }, unknown>; mutateAsync: UseMuta...` |
 
 Parameters:
 
@@ -705,7 +769,7 @@ Request a cancellation of an invite sent to another device.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useRequestCancelInvite` | `({ projectId }: { projectId: string; }) => { error: Error; mutate: UseMutateFunction<void, Error, { deviceId: string; }, unknown>; reset: () => void; status: "error"; } or { ...; }` |
+| `useRequestCancelInvite` | `({ projectId }: { projectId: string; }) => { error: Error; mutate: UseMutateFunction<void, Error, { deviceId: string; }, unknown>; mutateAsync: UseMutateAsyncFunction<void, Error, { ...; }, unknown>; reset: () => void; status: "error"; } or { ...; }` |
 
 Parameters:
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@comapeo/core-react",
-	"version": "3.3.0",
+	"version": "4.0.0",
 	"description": "React wrapper for working with @comapeo/core",
 	"repository": {
 		"type": "git",
@@ -57,15 +57,15 @@
 		"types": "tsc"
 	},
 	"peerDependencies": {
-		"@comapeo/core": "*",
-		"@comapeo/ipc": "*",
+		"@comapeo/core": "^3.0.0",
+		"@comapeo/ipc": "^3.0.0",
 		"@comapeo/schema": "*",
 		"@tanstack/react-query": "^5",
 		"react": "^18 || ^19"
 	},
 	"devDependencies": {
-		"@comapeo/core": "2.3.1",
-		"@comapeo/ipc": "2.1.0",
+		"@comapeo/core": "3.0.0",
+		"@comapeo/ipc": "3.0.0",
 		"@comapeo/schema": "1.4.1",
 		"@eslint/compat": "1.2.7",
 		"@eslint/js": "9.23.0",