@comapeo/core-react 3.0.0 → 3.2.0

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.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.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;
 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; } });
@@ -36,6 +36,7 @@ Object.defineProperty(exports, "useImportProjectConfig", { enumerable: true, get
 Object.defineProperty(exports, "useLeaveProject", { enumerable: true, get: function () { return projects_js_1.useLeaveProject; } });
 Object.defineProperty(exports, "useManyMembers", { enumerable: true, get: function () { return projects_js_1.useManyMembers; } });
 Object.defineProperty(exports, "useManyProjects", { enumerable: true, get: function () { return projects_js_1.useManyProjects; } });
+Object.defineProperty(exports, "useOwnRoleInProject", { enumerable: true, get: function () { return projects_js_1.useOwnRoleInProject; } });
 Object.defineProperty(exports, "useProjectSettings", { enumerable: true, get: function () { return projects_js_1.useProjectSettings; } });
 Object.defineProperty(exports, "useSingleMember", { enumerable: true, get: function () { return projects_js_1.useSingleMember; } });
 Object.defineProperty(exports, "useSingleProject", { enumerable: true, get: function () { return projects_js_1.useSingleProject; } });

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

@@ -61,20 +61,37 @@ 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>;
     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>;
+    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>;
+    reset: () => void;
+    status: "error";
+} | {
+    error: null;
     mutate: import("@tanstack/react-query").UseMutateFunction<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, reset, status } = useMutation(setOwnDeviceInfoMutationOptions({ clientApi, queryClient }));
+    return status === 'error'
+        ? { error, mutate, reset, status }
+        : { error: null, mutate, 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, status, reset } = useMutation(setIsArchiveDeviceMutationOptions({ clientApi, queryClient }));
+    return status === 'error'
+        ? { error, mutate, reset, status }
+        : { error: null, mutate, reset, status };
 }

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

@@ -119,13 +119,23 @@ 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>;
     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>;
+    reset: () => void;
+    status: "pending" | "success" | "idle";
 };
 /**
  * Update a document within a project.
@@ -137,6 +147,7 @@ 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, {
@@ -144,7 +155,17 @@ export declare function useUpdateDocument<D extends WriteableDocumentType>({ doc
         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>;
+    reset: () => void;
+    status: "pending" | "success" | "idle";
 };
 /**
  * Delete a document within a project.
@@ -156,12 +177,22 @@ 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>;
+    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>;
     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, reset, status } = useMutation(createDocumentMutationOptions({
         docType,
         projectApi,
         projectId,
         queryClient,
     }));
-    return { mutate, reset, status };
+    return status === 'error'
+        ? { error, mutate, reset, status }
+        : { error: null, mutate, 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, reset, status } = useMutation(updateDocumentMutationOptions({
         docType,
         projectApi,
         projectId,
         queryClient,
     }));
-    return { mutate, reset, status };
+    return status === 'error'
+        ? { error, mutate, reset, status }
+        : { error: null, mutate, 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, reset, status } = useMutation(deleteDocumentMutationOptions({
         docType,
         projectApi,
         projectId,
         queryClient,
     }));
-    return { mutate, reset, status };
+    return status === 'error'
+        ? { error, mutate, reset, status }
+        : { error: null, mutate, reset, status };
 }

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

@@ -2,21 +2,37 @@
  * Accept an invite that has been received.
  */
 export declare function useAcceptInvite(): {
+    error: Error;
     mutate: import("@tanstack/react-query").UseMutateFunction<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>;
+    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>;
+    reset: () => void;
+    status: "error";
+} | {
+    error: null;
     mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
         inviteId: string;
     }, unknown>;
     reset: () => void;
-    status: "pending" | "error" | "success" | "idle";
+    status: "pending" | "success" | "idle";
 };
 /**
  * Send an invite for a project.
@@ -26,6 +42,7 @@ 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;
@@ -33,7 +50,17 @@ export declare function useSendInvite({ projectId }: {
         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>;
+    reset: () => void;
+    status: "pending" | "success" | "idle";
 };
 /**
  * Request a cancellation of an invite sent to another device.
@@ -43,9 +70,17 @@ 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>;
+    reset: () => void;
+    status: "error";
+} | {
+    error: null;
     mutate: import("@tanstack/react-query").UseMutateFunction<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, reset, status } = useMutation(acceptInviteMutationOptions({ clientApi, queryClient }));
+    return status === 'error'
+        ? { error, mutate, reset, status }
+        : { error: null, mutate, 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, reset, status } = useMutation(rejectInviteMutationOptions({ clientApi, queryClient }));
+    return status === 'error'
+        ? { error, mutate, reset, status }
+        : { error: null, mutate, 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, reset, status } = useMutation(sendInviteMutationOptions({ projectApi, projectId, queryClient }));
+    return status === 'error'
+        ? { error, mutate, reset, status }
+        : { error: null, mutate, 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, reset, status } = useMutation(requestCancelInviteMutationOptions({ projectApi, queryClient }));
+    return status === 'error'
+        ? { error, mutate, reset, status }
+        : { error: null, mutate, reset, status };
 }

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

@@ -250,36 +250,84 @@ export declare function useDocumentCreatedBy({ projectId, originalVersionId, }:
     error: Error | null;
     isRefetching: boolean;
 };
+/**
+ * Get the role for the current device in a specified project.
+ * This is a more convenient alternative to using the `useOwnDeviceInfo` and `useManyMembers` hooks.
+ *
+ * @param opts.projectId Project public ID
+ *
+ * @example
+ * ```tsx
+ * function BasicExample() {
+ *   const { data } = useOwnRoleInProject({
+ *     projectId: '...',
+ *   })
+ * }
+ * ```
+ */
+export declare function useOwnRoleInProject({ projectId }: {
+    projectId: string;
+}): {
+    data: import("@comapeo/core/dist/roles.js").Role<"a12a6702b93bd7ff" | "f7c150f5a3a9a855" | "012fd2d431c0bf60" | "9e6d29263cba36c9" | "8ced989b1904606b" | "08e4251e36f6e7ed">;
+    error: Error | null;
+    isRefetching: boolean;
+};
 export declare function useAddServerPeer({ projectId }: {
     projectId: string;
 }): {
+    error: Error;
+    mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
+        baseUrl: string;
+        dangerouslyAllowInsecureConnections?: boolean;
+    }, unknown>;
+    reset: () => void;
+    status: "error";
+} | {
+    error: null;
     mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
         baseUrl: string;
         dangerouslyAllowInsecureConnections?: boolean;
     }, unknown>;
     reset: () => void;
-    status: "pending" | "error" | "success" | "idle";
+    status: "pending" | "success" | "idle";
 };
 /**
  * Create a new project.
  */
 export declare function useCreateProject(): {
+    error: Error;
     mutate: import("@tanstack/react-query").UseMutateFunction<string, Error, {
         name?: string;
         configPath?: string;
     } | undefined, unknown>;
     reset: () => void;
-    status: "pending" | "error" | "success" | "idle";
+    status: "error";
+} | {
+    error: null;
+    mutate: import("@tanstack/react-query").UseMutateFunction<string, Error, {
+        name?: string;
+        configPath?: string;
+    } | undefined, unknown>;
+    reset: () => void;
+    status: "pending" | "success" | "idle";
 };
 /**
  * Leave an existing project.
  */
 export declare function useLeaveProject(): {
+    error: Error;
     mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
         projectId: string;
     }, unknown>;
     reset: () => void;
-    status: "pending" | "error" | "success" | "idle";
+    status: "error";
+} | {
+    error: null;
+    mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
+        projectId: string;
+    }, unknown>;
+    reset: () => void;
+    status: "pending" | "success" | "idle";
 };
 /**
  * Update the configuration of a project using an external file.
@@ -289,11 +337,19 @@ export declare function useLeaveProject(): {
 export declare function useImportProjectConfig({ projectId }: {
     projectId: string;
 }): {
+    error: Error;
+    mutate: import("@tanstack/react-query").UseMutateFunction<Error[], Error, {
+        configPath: string;
+    }, unknown>;
+    reset: () => void;
+    status: "error";
+} | {
+    error: null;
     mutate: import("@tanstack/react-query").UseMutateFunction<Error[], Error, {
         configPath: string;
     }, unknown>;
     reset: () => void;
-    status: "pending" | "error" | "success" | "idle";
+    status: "pending" | "success" | "idle";
 };
 /**
  * Update the settings of a project.
@@ -303,13 +359,23 @@ export declare function useImportProjectConfig({ projectId }: {
 export declare function useUpdateProjectSettings({ projectId }: {
     projectId: string;
 }): {
+    error: Error;
     mutate: import("@tanstack/react-query").UseMutateFunction<import("@comapeo/core/dist/mapeo-project.js").EditableProjectSettings, Error, {
         name?: import("@comapeo/schema").ProjectSettings["name"];
         configMetadata?: import("@comapeo/schema").ProjectSettings["configMetadata"];
         defaultPresets?: import("@comapeo/schema").ProjectSettings["defaultPresets"];
     }, unknown>;
     reset: () => void;
-    status: "pending" | "error" | "success" | "idle";
+    status: "error";
+} | {
+    error: null;
+    mutate: import("@tanstack/react-query").UseMutateFunction<import("@comapeo/core/dist/mapeo-project.js").EditableProjectSettings, Error, {
+        name?: import("@comapeo/schema").ProjectSettings["name"];
+        configMetadata?: import("@comapeo/schema").ProjectSettings["configMetadata"];
+        defaultPresets?: import("@comapeo/schema").ProjectSettings["defaultPresets"];
+    }, unknown>;
+    reset: () => void;
+    status: "pending" | "success" | "idle";
 };
 /**
  * Create a blob for a project.
@@ -319,6 +385,7 @@ export declare function useUpdateProjectSettings({ projectId }: {
 export declare function useCreateBlob({ projectId }: {
     projectId: string;
 }): {
+    error: Error;
     mutate: import("@tanstack/react-query").UseMutateFunction<{
         driveId: string;
         name: string;
@@ -331,7 +398,22 @@ export declare function useCreateBlob({ projectId }: {
         metadata: import("@comapeo/core/dist/blob-api.js").Metadata;
     }, unknown>;
     reset: () => void;
-    status: "pending" | "error" | "success" | "idle";
+    status: "error";
+} | {
+    error: null;
+    mutate: import("@tanstack/react-query").UseMutateFunction<{
+        driveId: string;
+        name: string;
+        type: "photo" | "video" | "audio";
+        hash: string;
+    }, Error, {
+        original: string;
+        preview?: string;
+        thumbnail?: string;
+        metadata: import("@comapeo/core/dist/blob-api.js").Metadata;
+    }, unknown>;
+    reset: () => void;
+    status: "pending" | "success" | "idle";
 };
 /**
  * Hook to subscribe to the current sync state.
@@ -369,16 +451,30 @@ export declare function useDataSyncProgress({ projectId, }: {
 export declare function useStartSync({ projectId }: {
     projectId: string;
 }): {
+    error: Error;
     mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
         autostopDataSyncAfter: number | null;
     } | undefined, unknown>;
     reset: () => void;
-    status: "pending" | "error" | "success" | "idle";
+    status: "error";
+} | {
+    error: null;
+    mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
+        autostopDataSyncAfter: number | null;
+    } | undefined, unknown>;
+    reset: () => void;
+    status: "pending" | "success" | "idle";
 };
 export declare function useStopSync({ projectId }: {
     projectId: string;
 }): {
+    error: Error;
+    mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, void, unknown>;
+    reset: () => void;
+    status: "error";
+} | {
+    error: null;
     mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, void, unknown>;
     reset: () => void;
-    status: "pending" | "error" | "success" | "idle";
+    status: "pending" | "success" | "idle";
 };