@comapeo/core-react 3.1.0 → 3.3.0

package/dist/commonjs/hooks/projects.js

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

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

@@ -61,20 +61,51 @@ export declare function useIsArchiveDevice(): {
  * Update the device info for the current device.
  */
 export declare function useSetOwnDeviceInfo(): {
+    error: Error;
     mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
         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" | "error" | "success" | "idle";
+    status: "error";
+} | {
+    error: null;
+    mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
+        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";
 };
 /**
  * Set or unset the current device as an archive device.
  */
 export declare function useSetIsArchiveDevice(): {
+    error: Error;
     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";
+} | {
+    error: null;
+    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" | "error" | "success" | "idle";
+    status: "pending" | "success" | "idle";
 };

package/dist/esm/hooks/client.js

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

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

@@ -119,13 +119,33 @@ export declare function useCreateDocument<D extends WriteableDocumentType>({ doc
     docType: D;
     projectId: string;
 }): {
+    error: Error;
     mutate: import("@tanstack/react-query").UseMutateFunction<import("../lib/types.js").WriteableDocument<D> & {
         forks: Array<string>;
     }, 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" | "error" | "success" | "idle";
+    status: "error";
+} | {
+    error: null;
+    mutate: import("@tanstack/react-query").UseMutateFunction<import("../lib/types.js").WriteableDocument<D> & {
+        forks: Array<string>;
+    }, 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";
 };
 /**
  * Update a document within a project.
@@ -137,14 +157,37 @@ export declare function useUpdateDocument<D extends WriteableDocumentType>({ doc
     docType: D;
     projectId: string;
 }): {
+    error: Error;
     mutate: import("@tanstack/react-query").UseMutateFunction<import("../lib/types.js").WriteableDocument<D> & {
         forks: Array<string>;
     }, Error, {
         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" | "error" | "success" | "idle";
+    status: "error";
+} | {
+    error: null;
+    mutate: import("@tanstack/react-query").UseMutateFunction<import("../lib/types.js").WriteableDocument<D> & {
+        forks: Array<string>;
+    }, Error, {
+        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";
 };
 /**
  * Delete a document within a project.
@@ -156,12 +199,32 @@ export declare function useDeleteDocument<D extends WriteableDocumentType>({ doc
     docType: D;
     projectId: string;
 }): {
+    error: Error;
+    mutate: import("@tanstack/react-query").UseMutateFunction<import("../lib/types.js").WriteableDocument<D> & {
+        forks: Array<string>;
+    }, 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";
+} | {
+    error: null;
     mutate: import("@tanstack/react-query").UseMutateFunction<import("../lib/types.js").WriteableDocument<D> & {
         forks: Array<string>;
     }, 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" | "error" | "success" | "idle";
+    status: "pending" | "success" | "idle";
 };
 export {};

package/dist/esm/hooks/documents.js

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

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

@@ -2,21 +2,49 @@
  * Accept an invite that has been received.
  */
 export declare function useAcceptInvite(): {
+    error: Error;
     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" | "error" | "success" | "idle";
+    status: "error";
+} | {
+    error: null;
+    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";
 };
 /**
  * Reject an invite that has been received.
  */
 export declare function useRejectInvite(): {
+    error: Error;
     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" | "error" | "success" | "idle";
+    status: "error";
+} | {
+    error: null;
+    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";
 };
 /**
  * Send an invite for a project.
@@ -26,14 +54,37 @@ export declare function useRejectInvite(): {
 export declare function useSendInvite({ projectId }: {
     projectId: string;
 }): {
+    error: Error;
     mutate: import("@tanstack/react-query").UseMutateFunction<"ACCEPT" | "REJECT" | "ALREADY", Error, {
         deviceId: string;
         roleDescription?: string;
         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" | "error" | "success" | "idle";
+    status: "error";
+} | {
+    error: null;
+    mutate: import("@tanstack/react-query").UseMutateFunction<"ACCEPT" | "REJECT" | "ALREADY", Error, {
+        deviceId: string;
+        roleDescription?: string;
+        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";
 };
 /**
  * Request a cancellation of an invite sent to another device.
@@ -43,9 +94,23 @@ export declare function useSendInvite({ projectId }: {
 export declare function useRequestCancelInvite({ projectId }: {
     projectId: string;
 }): {
+    error: Error;
+    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";
+} | {
+    error: null;
     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" | "error" | "success" | "idle";
+    status: "pending" | "success" | "idle";
 };

package/dist/esm/hooks/invites.js

@@ -8,8 +8,10 @@ import { useSingleProject } from './projects.js';
 export function useAcceptInvite() {
     const queryClient = useQueryClient();
     const clientApi = useClientApi();
-    const { mutate, status, reset } = useMutation(acceptInviteMutationOptions({ clientApi, queryClient }));
-    return { mutate, reset, status };
+    const { error, mutate, mutateAsync, reset, status } = useMutation(acceptInviteMutationOptions({ clientApi, queryClient }));
+    return status === 'error'
+        ? { error, mutate, mutateAsync, reset, status }
+        : { error: null, mutate, mutateAsync, reset, status };
 }
 /**
  * Reject an invite that has been received.
@@ -17,8 +19,10 @@ export function useAcceptInvite() {
 export function useRejectInvite() {
     const queryClient = useQueryClient();
     const clientApi = useClientApi();
-    const { mutate, status, reset } = useMutation(rejectInviteMutationOptions({ clientApi, queryClient }));
-    return { mutate, reset, status };
+    const { error, mutate, mutateAsync, reset, status } = useMutation(rejectInviteMutationOptions({ clientApi, queryClient }));
+    return status === 'error'
+        ? { error, mutate, mutateAsync, reset, status }
+        : { error: null, mutate, mutateAsync, reset, status };
 }
 /**
  * Send an invite for a project.
@@ -28,8 +32,10 @@ export function useRejectInvite() {
 export function useSendInvite({ projectId }) {
     const queryClient = useQueryClient();
     const { data: projectApi } = useSingleProject({ projectId });
-    const { mutate, status, reset } = useMutation(sendInviteMutationOptions({ projectApi, projectId, queryClient }));
-    return { mutate, reset, status };
+    const { error, mutate, mutateAsync, reset, status } = useMutation(sendInviteMutationOptions({ projectApi, projectId, queryClient }));
+    return status === 'error'
+        ? { error, mutate, mutateAsync, reset, status }
+        : { error: null, mutate, mutateAsync, reset, status };
 }
 /**
  * Request a cancellation of an invite sent to another device.
@@ -39,6 +45,8 @@ export function useSendInvite({ projectId }) {
 export function useRequestCancelInvite({ projectId }) {
     const queryClient = useQueryClient();
     const { data: projectApi } = useSingleProject({ projectId });
-    const { mutate, status, reset } = useMutation(requestCancelInviteMutationOptions({ projectApi, queryClient }));
-    return { mutate, reset, status };
+    const { error, mutate, mutateAsync, reset, status } = useMutation(requestCancelInviteMutationOptions({ projectApi, queryClient }));
+    return status === 'error'
+        ? { error, mutate, mutateAsync, reset, status }
+        : { error: null, mutate, mutateAsync, reset, status };
 }