@comapeo/core-react 3.0.0 → 3.2.0

package/dist/esm/hooks/projects.js

@@ -1,6 +1,6 @@
 import { useMutation, useQueryClient, useSuspenseQuery, } from '@tanstack/react-query';
 import { useSyncExternalStore } from 'react';
-import { addServerPeerMutationOptions, attachmentUrlQueryOptions, createBlobMutationOptions, createProjectMutationOptions, documentCreatedByQueryOptions, iconUrlQueryOptions, importProjectConfigMutationOptions, leaveProjectMutationOptions, projectByIdQueryOptions, projectMemberByIdQueryOptions, projectMembersQueryOptions, projectSettingsQueryOptions, projectsQueryOptions, startSyncMutationOptions, stopSyncMutationOptions, updateProjectSettingsMutationOptions, } from '../lib/react-query/projects.js';
+import { addServerPeerMutationOptions, attachmentUrlQueryOptions, createBlobMutationOptions, createProjectMutationOptions, documentCreatedByQueryOptions, iconUrlQueryOptions, importProjectConfigMutationOptions, leaveProjectMutationOptions, projectByIdQueryOptions, projectMemberByIdQueryOptions, projectMembersQueryOptions, projectOwnRoleQueryOptions, projectSettingsQueryOptions, projectsQueryOptions, startSyncMutationOptions, stopSyncMutationOptions, updateProjectSettingsMutationOptions, } from '../lib/react-query/projects.js';
 import { SyncStore } from '../lib/sync.js';
 import { useClientApi } from './client.js';
 /**
@@ -248,11 +248,33 @@ export function useDocumentCreatedBy({ projectId, originalVersionId, }) {
     const { data, error, isRefetching } = useSuspenseQuery(documentCreatedByQueryOptions({ projectApi, projectId, originalVersionId }));
     return { data, error, isRefetching };
 }
+/**
+ * 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 function useOwnRoleInProject({ projectId }) {
+    const { data: projectApi } = useSingleProject({ projectId });
+    const { data, error, isRefetching } = useSuspenseQuery(projectOwnRoleQueryOptions({ projectApi, projectId }));
+    return { data, error, isRefetching };
+}
 export function useAddServerPeer({ projectId }) {
     const queryClient = useQueryClient();
     const { data: projectApi } = useSingleProject({ projectId });
-    const { mutate, reset, status } = useMutation(addServerPeerMutationOptions({ projectApi, projectId, queryClient }));
-    return { mutate, reset, status };
+    const { error, mutate, reset, status } = useMutation(addServerPeerMutationOptions({ projectApi, projectId, queryClient }));
+    return status === 'error'
+        ? { error, mutate, reset, status }
+        : { error: null, mutate, reset, status };
 }
 /**
  * Create a new project.
@@ -260,8 +282,10 @@ export function useAddServerPeer({ projectId }) {
 export function useCreateProject() {
     const queryClient = useQueryClient();
     const clientApi = useClientApi();
-    const { mutate, status, reset } = useMutation(createProjectMutationOptions({ clientApi, queryClient }));
-    return { mutate, reset, status };
+    const { error, mutate, reset, status } = useMutation(createProjectMutationOptions({ clientApi, queryClient }));
+    return status === 'error'
+        ? { error, mutate, reset, status }
+        : { error: null, mutate, reset, status };
 }
 /**
  * Leave an existing project.
@@ -269,8 +293,10 @@ export function useCreateProject() {
 export function useLeaveProject() {
     const queryClient = useQueryClient();
     const clientApi = useClientApi();
-    const { mutate, status, reset } = useMutation(leaveProjectMutationOptions({ clientApi, queryClient }));
-    return { mutate, reset, status };
+    const { error, mutate, reset, status } = useMutation(leaveProjectMutationOptions({ clientApi, queryClient }));
+    return status === 'error'
+        ? { error, mutate, reset, status }
+        : { error: null, mutate, reset, status };
 }
 /**
  * Update the configuration of a project using an external file.
@@ -280,8 +306,10 @@ export function useLeaveProject() {
 export function useImportProjectConfig({ projectId }) {
     const queryClient = useQueryClient();
     const { data: projectApi } = useSingleProject({ projectId });
-    const { mutate, status, reset } = useMutation(importProjectConfigMutationOptions({ queryClient, projectApi, projectId }));
-    return { mutate, reset, status };
+    const { error, mutate, reset, status } = useMutation(importProjectConfigMutationOptions({ queryClient, projectApi, projectId }));
+    return status === 'error'
+        ? { error, mutate, reset, status }
+        : { error: null, mutate, reset, status };
 }
 /**
  * Update the settings of a project.
@@ -291,8 +319,10 @@ export function useImportProjectConfig({ projectId }) {
 export function useUpdateProjectSettings({ projectId }) {
     const queryClient = useQueryClient();
     const { data: projectApi } = useSingleProject({ projectId });
-    const { mutate, reset, status } = useMutation(updateProjectSettingsMutationOptions({ projectApi, queryClient }));
-    return { mutate, reset, status };
+    const { error, mutate, reset, status } = useMutation(updateProjectSettingsMutationOptions({ projectApi, queryClient }));
+    return status === 'error'
+        ? { error, mutate, reset, status }
+        : { error: null, mutate, reset, status };
 }
 /**
  * Create a blob for a project.
@@ -301,8 +331,10 @@ export function useUpdateProjectSettings({ projectId }) {
  */
 export function useCreateBlob({ projectId }) {
     const { data: projectApi } = useSingleProject({ projectId });
-    const { mutate, reset, status } = useMutation(createBlobMutationOptions({ projectApi }));
-    return { mutate, reset, status };
+    const { error, mutate, reset, status } = useMutation(createBlobMutationOptions({ projectApi }));
+    return status === 'error'
+        ? { error, mutate, reset, status }
+        : { error: null, mutate, reset, status };
 }
 const PROJECT_SYNC_STORE_MAP = new WeakMap();
 function useSyncStore({ projectId }) {
@@ -352,11 +384,15 @@ export function useDataSyncProgress({ projectId, }) {
 }
 export function useStartSync({ projectId }) {
     const { data: projectApi } = useSingleProject({ projectId });
-    const { mutate, reset, status } = useMutation(startSyncMutationOptions({ projectApi }));
-    return { mutate, reset, status };
+    const { mutate, reset, status, error } = useMutation(startSyncMutationOptions({ projectApi }));
+    return status === 'error'
+        ? { error, mutate, reset, status }
+        : { error: null, mutate, reset, status };
 }
 export function useStopSync({ projectId }) {
     const { data: projectApi } = useSingleProject({ projectId });
-    const { mutate, reset, status } = useMutation(stopSyncMutationOptions({ projectApi }));
-    return { mutate, reset, status };
+    const { error, mutate, reset, status } = useMutation(stopSyncMutationOptions({ projectApi }));
+    return status === 'error'
+        ? { error, mutate, reset, status }
+        : { error: null, mutate, reset, status };
 }

package/dist/esm/index.d.ts

@@ -3,6 +3,6 @@ export { useClientApi, useIsArchiveDevice, useOwnDeviceInfo, useSetIsArchiveDevi
 export { useCreateDocument, useDeleteDocument, useManyDocs, useSingleDocByDocId, useSingleDocByVersionId, useUpdateDocument, } from './hooks/documents.js';
 export { useAcceptInvite, useRejectInvite, useRequestCancelInvite, useSendInvite, } from './hooks/invites.js';
 export { useMapStyleUrl } from './hooks/maps.js';
-export { useAddServerPeer, useAttachmentUrl, useCreateBlob, useCreateProject, useDataSyncProgress, useDocumentCreatedBy, useIconUrl, useImportProjectConfig, useLeaveProject, useManyMembers, useManyProjects, useProjectSettings, useSingleMember, useSingleProject, useStartSync, useStopSync, useSyncState, useUpdateProjectSettings, } from './hooks/projects.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';
 export { type WriteableDocument, type WriteableDocumentType, type WriteableValue, } from './lib/types.js';

package/dist/esm/index.js

@@ -3,4 +3,4 @@ export { useClientApi, useIsArchiveDevice, useOwnDeviceInfo, useSetIsArchiveDevi
 export { useCreateDocument, useDeleteDocument, useManyDocs, useSingleDocByDocId, useSingleDocByVersionId, useUpdateDocument, } from './hooks/documents.js';
 export { useAcceptInvite, useRejectInvite, useRequestCancelInvite, useSendInvite, } from './hooks/invites.js';
 export { useMapStyleUrl } from './hooks/maps.js';
-export { useAddServerPeer, useAttachmentUrl, useCreateBlob, useCreateProject, useDataSyncProgress, useDocumentCreatedBy, useIconUrl, useImportProjectConfig, useLeaveProject, useManyMembers, useManyProjects, useProjectSettings, useSingleMember, useSingleProject, useStartSync, useStopSync, useSyncState, useUpdateProjectSettings, } from './hooks/projects.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/docs/API.md

@@ -14,6 +14,7 @@
 - [useIconUrl](#useiconurl)
 - [useAttachmentUrl](#useattachmenturl)
 - [useDocumentCreatedBy](#usedocumentcreatedby)
+- [useOwnRoleInProject](#useownroleinproject)
 - [useAddServerPeer](#useaddserverpeer)
 - [useCreateProject](#usecreateproject)
 - [useLeaveProject](#useleaveproject)
@@ -119,7 +120,7 @@ Update the device info for the current device.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useSetOwnDeviceInfo` | `() => { mutate: UseMutateFunction<void, Error, { name: string; deviceType: "device_type_unspecified" or "mobile" or "tablet" or "desktop" or "selfHostedServer" or "UNRECOGNIZED"; }, unknown>; reset: () => void; status: "pending" or ... 2 more ... or "idle"; }` |
+| `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 { ...; }` |
 
 ### useSetIsArchiveDevice
 
@@ -127,7 +128,7 @@ Set or unset the current device as an archive device.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useSetIsArchiveDevice` | `() => { mutate: UseMutateFunction<void, Error, { isArchiveDevice: boolean; }, unknown>; reset: () => void; status: "pending" or "error" or "success" or "idle"; }` |
+| `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"; }` |
 
 ### useProjectSettings
 
@@ -377,11 +378,36 @@ function BasicExample() {
 ```
 
 
+### useOwnRoleInProject
+
+Get the role for the current device in a specified project.
+This is a more convenient alternative to using the `useOwnDeviceInfo` and `useManyMembers` hooks.
+
+| Function | Type |
+| ---------- | ---------- |
+| `useOwnRoleInProject` | `({ projectId }: { projectId: string; }) => { data: Role<"a12a6702b93bd7ff" or "f7c150f5a3a9a855" or "012fd2d431c0bf60" or "9e6d29263cba36c9" or "8ced989b1904606b" or "08e4251e36f6e7ed">; error: Error or null; isRefetching: boolean; }` |
+
+Parameters:
+
+* `opts.projectId`: Project public ID
+
+
+Examples:
+
+```tsx
+function BasicExample() {
+  const { data } = useOwnRoleInProject({
+    projectId: '...',
+  })
+}
+```
+
+
 ### useAddServerPeer
 
 | Function | Type |
 | ---------- | ---------- |
-| `useAddServerPeer` | `({ projectId }: { projectId: string; }) => { mutate: UseMutateFunction<void, Error, { baseUrl: string; dangerouslyAllowInsecureConnections?: boolean or undefined; }, unknown>; reset: () => void; status: "pending" or ... 2 more ... or "idle"; }` |
+| `useAddServerPeer` | `({ projectId }: { projectId: string; }) => { error: Error; mutate: UseMutateFunction<void, Error, { baseUrl: string; dangerouslyAllowInsecureConnections?: boolean or undefined; }, unknown>; reset: () => void; status: "error"; } or { ...; }` |
 
 ### useCreateProject
 
@@ -389,7 +415,7 @@ Create a new project.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useCreateProject` | `() => { mutate: UseMutateFunction<string, Error, { name?: string or undefined; configPath?: string or undefined; } or undefined, unknown>; reset: () => void; status: "pending" or ... 2 more ... or "idle"; }` |
+| `useCreateProject` | `() => { error: Error; mutate: UseMutateFunction<string, Error, { name?: string or undefined; configPath?: string or undefined; } or undefined, unknown>; reset: () => void; status: "error"; } or { ...; }` |
 
 ### useLeaveProject
 
@@ -397,7 +423,7 @@ Leave an existing project.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useLeaveProject` | `() => { mutate: UseMutateFunction<void, Error, { projectId: string; }, unknown>; reset: () => void; status: "pending" or "error" or "success" or "idle"; }` |
+| `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"; }` |
 
 ### useImportProjectConfig
 
@@ -405,7 +431,7 @@ Update the configuration of a project using an external file.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useImportProjectConfig` | `({ projectId }: { projectId: string; }) => { mutate: UseMutateFunction<Error[], Error, { configPath: string; }, unknown>; reset: () => void; status: "pending" or "error" or "success" or "idle"; }` |
+| `useImportProjectConfig` | `({ projectId }: { projectId: string; }) => { error: Error; mutate: UseMutateFunction<Error[], Error, { configPath: string; }, unknown>; reset: () => void; status: "error"; } or { ...; }` |
 
 Parameters:
 
@@ -418,7 +444,7 @@ Update the settings of a project.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useUpdateProjectSettings` | `({ projectId }: { projectId: string; }) => { mutate: UseMutateFunction<EditableProjectSettings, Error, { name?: string or undefined; configMetadata?: { name: string; buildDate: string; importDate: string; fileVersion: string; } or undefined; defaultPresets?: { ...; } or undefined; }, unknown>; reset: () => void; status...` |
+| `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 { ...; }` |
 
 Parameters:
 
@@ -431,7 +457,7 @@ Create a blob for a project.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useCreateBlob` | `({ projectId }: { projectId: string; }) => { 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: "pending" or ...` |
+| `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...` |
 
 Parameters:
 
@@ -482,13 +508,13 @@ Provides the progress of data sync for sync-enabled connected peers
 
 | Function | Type |
 | ---------- | ---------- |
-| `useStartSync` | `({ projectId }: { projectId: string; }) => { mutate: UseMutateFunction<void, Error, { autostopDataSyncAfter: number or null; } or undefined, unknown>; reset: () => void; status: "pending" or ... 2 more ... or "idle"; }` |
+| `useStartSync` | `({ projectId }: { projectId: string; }) => { error: Error; mutate: UseMutateFunction<void, Error, { autostopDataSyncAfter: number or null; } or undefined, unknown>; reset: () => void; status: "error"; } or { ...; }` |
 
 ### useStopSync
 
 | Function | Type |
 | ---------- | ---------- |
-| `useStopSync` | `({ projectId }: { projectId: string; }) => { mutate: UseMutateFunction<void, Error, void, unknown>; reset: () => void; status: "pending" or "error" or "success" or "idle"; }` |
+| `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"; }` |
 
 ### useSingleDocByDocId
 
@@ -608,7 +634,7 @@ Create a document for a project.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useCreateDocument` | `<D extends WriteableDocumentType>({ docType, projectId, }: { docType: D; projectId: string; }) => { mutate: UseMutateFunction<WriteableDocument<D> and { forks: string[]; }, Error, { value: Omit<WriteableValue<D>, "schemaName">; }, unknown>; reset: () => void; status: "pending" or ... 2 more ... or "idle"; }` |
+| `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 { ...; }` |
 
 Parameters:
 
@@ -622,7 +648,7 @@ Update a document within a project.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useUpdateDocument` | `<D extends WriteableDocumentType>({ docType, projectId, }: { docType: D; projectId: string; }) => { mutate: UseMutateFunction<WriteableDocument<D> and { forks: string[]; }, Error, { versionId: string; value: Omit<...>; }, unknown>; reset: () => void; status: "pending" or ... 2 more ... or "idle"; }` |
+| `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 { ...; }` |
 
 Parameters:
 
@@ -636,7 +662,7 @@ Delete a document within a project.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useDeleteDocument` | `<D extends WriteableDocumentType>({ docType, projectId, }: { docType: D; projectId: string; }) => { mutate: UseMutateFunction<WriteableDocument<D> and { forks: string[]; }, Error, { docId: string; }, unknown>; reset: () => void; status: "pending" or ... 2 more ... or "idle"; }` |
+| `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 { ...; }` |
 
 Parameters:
 
@@ -650,7 +676,7 @@ Accept an invite that has been received.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useAcceptInvite` | `() => { mutate: UseMutateFunction<string, Error, { inviteId: string; }, unknown>; reset: () => void; status: "pending" or "error" or "success" or "idle"; }` |
+| `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"; }` |
 
 ### useRejectInvite
 
@@ -658,7 +684,7 @@ Reject an invite that has been received.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useRejectInvite` | `() => { mutate: UseMutateFunction<void, Error, { inviteId: string; }, unknown>; reset: () => void; status: "pending" or "error" or "success" or "idle"; }` |
+| `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"; }` |
 
 ### useSendInvite
 
@@ -666,7 +692,7 @@ Send an invite for a project.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useSendInvite` | `({ projectId }: { projectId: string; }) => { 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; status: "pendin...` |
+| `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...` |
 
 Parameters:
 
@@ -679,7 +705,7 @@ Request a cancellation of an invite sent to another device.
 
 | Function | Type |
 | ---------- | ---------- |
-| `useRequestCancelInvite` | `({ projectId }: { projectId: string; }) => { mutate: UseMutateFunction<void, Error, { deviceId: string; }, unknown>; reset: () => void; status: "pending" or "error" or "success" or "idle"; }` |
+| `useRequestCancelInvite` | `({ projectId }: { projectId: string; }) => { error: Error; mutate: UseMutateFunction<void, Error, { deviceId: string; }, unknown>; reset: () => void; status: "error"; } or { ...; }` |
 
 Parameters:
 

package/package.json

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