@comapeo/core-react 7.1.0 → 8.0.0

package/dist/commonjs/contexts/ClientApi.d.ts

@@ -1,4 +1,6 @@
-import type { MapeoClientApi } from '@comapeo/ipc' with { 'resolution-mode': 'import' };
+import type { MapeoClientApi } from '@comapeo/ipc' with {
+    'resolution-mode': 'import'
+};
 import { type Context, type JSX, type ReactNode } from 'react';
 export declare const ClientApiContext: Context<MapeoClientApi | null>;
 /**

package/dist/commonjs/contexts/ClientApi.js

@@ -2,7 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ClientApiContext = void 0;
 exports.ClientApiProvider = ClientApiProvider;
+const react_query_1 = require("@tanstack/react-query");
 const react_1 = require("react");
+const invites_js_1 = require("../lib/react-query/invites.js");
 exports.ClientApiContext = (0, react_1.createContext)(null);
 /**
  * Create a context provider that holds a CoMapeo API client instance.
@@ -12,5 +14,17 @@ exports.ClientApiContext = (0, react_1.createContext)(null);
  *
  */
 function ClientApiProvider({ children, clientApi, }) {
+    const queryClient = (0, react_query_1.useQueryClient)();
+    (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]);
     return (0, react_1.createElement)(exports.ClientApiContext.Provider, { value: clientApi }, children);
 }

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

@@ -1,4 +1,6 @@
-import type { MapeoClientApi } from '@comapeo/ipc' with { 'resolution-mode': 'import' };
+import type { MapeoClientApi } from '@comapeo/ipc' with {
+    'resolution-mode': 'import'
+};
 /**
  * Access a client API instance. If a ClientApiContext provider is not
  * set up, it will throw an error.

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

@@ -1,4 +1,6 @@
-import type { Preset } from '@comapeo/schema' with { 'resolution-mode': 'import' };
+import type { Preset } from '@comapeo/schema' with {
+    'resolution-mode': 'import'
+};
 import type { WriteableDocumentType } from '../lib/types.js';
 /**
  * Retrieve a single document from the database based on the document's document ID.

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

@@ -1,19 +1,3 @@
-/**
- * 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.
  *

package/dist/commonjs/hooks/invites.js

@@ -1,6 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.useSetUpInvitesListeners = useSetUpInvitesListeners;
 exports.useManyInvites = useManyInvites;
 exports.useSingleInvite = useSingleInvite;
 exports.useAcceptInvite = useAcceptInvite;
@@ -8,40 +7,9 @@ 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.
  *

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

@@ -1,5 +1,12 @@
-import type { BlobApi, IconApi } from '@comapeo/core' with { 'resolution-mode': 'import' };
-import type { MapeoProjectApi } from '@comapeo/ipc' with { 'resolution-mode': 'import' };
+import type { BlobApi, IconApi } from '@comapeo/core' with {
+    'resolution-mode': 'import'
+};
+import type { RoleChangeEvent } from '@comapeo/core/dist/mapeo-project.js' with {
+    'resolution-mode': 'import'
+};
+import type { MapeoProjectApi } from '@comapeo/ipc' with {
+    'resolution-mode': 'import'
+};
 import { type SyncState } from '../lib/sync.js';
 /**
  * Retrieve the project settings for a project.
@@ -318,10 +325,14 @@ export declare function useCreateProject(): {
     mutate: import("@tanstack/react-query").UseMutateFunction<string, Error, {
         name?: string;
         configPath?: string;
+        projectColor?: string;
+        projectDescription?: string;
     } | undefined, unknown>;
     mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<string, Error, {
         name?: string;
         configPath?: string;
+        projectColor?: string;
+        projectDescription?: string;
     } | undefined, unknown>;
     reset: () => void;
     status: "error";
@@ -330,10 +341,14 @@ export declare function useCreateProject(): {
     mutate: import("@tanstack/react-query").UseMutateFunction<string, Error, {
         name?: string;
         configPath?: string;
+        projectColor?: string;
+        projectDescription?: string;
     } | undefined, unknown>;
     mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<string, Error, {
         name?: string;
         configPath?: string;
+        projectColor?: string;
+        projectDescription?: string;
     } | undefined, unknown>;
     reset: () => void;
     status: "pending" | "success" | "idle";
@@ -531,15 +546,31 @@ export declare function useRemoveMember({ projectId }: {
  * It is necessary to use this if you want the project role-related read hooks to update
  * based on role change events that are received in the background.
  *
+ * @param opts.listener Optional listener to invoke when role changes
+ *
  * @example
  * ```tsx
  * function SomeComponent({ projectId }: { projectId: string }) {
  *   useProjectOwnRoleChangeListener({ projectId })
  * }
  * ```
+ *
+ * @example
+ * ```tsx
+ * function ComponentWithListener({ projectId }: { projectId: string }) {
+ *   useProjectOwnRoleChangeListener({
+ *     projectId,
+ *     listener: (event) => {
+ *       // Handle role change, e.g., navigate to default project
+ *       console.log('New role:', event.role)
+ *     }
+ *   })
+ * }
+ * ```
  */
-export declare function useProjectOwnRoleChangeListener({ projectId, }: {
+export declare function useProjectOwnRoleChangeListener({ projectId, listener, }: {
     projectId: string;
+    listener?: (event: RoleChangeEvent) => void;
 }): void;
 /**
  * Create a blob for a project.

package/dist/commonjs/hooks/projects.js

@@ -446,14 +446,29 @@ function useRemoveMember({ projectId }) {
  * It is necessary to use this if you want the project role-related read hooks to update
  * based on role change events that are received in the background.
  *
+ * @param opts.listener Optional listener to invoke when role changes
+ *
  * @example
  * ```tsx
  * function SomeComponent({ projectId }: { projectId: string }) {
  *   useProjectOwnRoleChangeListener({ projectId })
  * }
  * ```
+ *
+ * @example
+ * ```tsx
+ * function ComponentWithListener({ projectId }: { projectId: string }) {
+ *   useProjectOwnRoleChangeListener({
+ *     projectId,
+ *     listener: (event) => {
+ *       // Handle role change, e.g., navigate to default project
+ *       console.log('New role:', event.role)
+ *     }
+ *   })
+ * }
+ * ```
  */
-function useProjectOwnRoleChangeListener({ projectId, }) {
+function useProjectOwnRoleChangeListener({ projectId, listener, }) {
     const queryClient = (0, react_query_1.useQueryClient)();
     const { data: projectApi } = useSingleProject({ projectId });
     (0, react_1.useEffect)(() => {
@@ -470,6 +485,16 @@ function useProjectOwnRoleChangeListener({ projectId, }) {
             projectApi.removeListener('own-role-change', invalidateCache);
         };
     }, [projectApi, queryClient, projectId]);
+    (0, react_1.useEffect)(() => {
+        if (listener) {
+            projectApi.addListener('own-role-change', listener);
+        }
+        return () => {
+            if (listener) {
+                projectApi.removeListener('own-role-change', listener);
+            }
+        };
+    }, [projectApi, listener]);
 }
 /**
  * Create a blob for a project.

package/dist/commonjs/index.d.ts

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

package/dist/commonjs/index.js

@@ -1,9 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.useExportGeoJSON = exports.useChangeMemberRole = exports.useUpdateProjectSettings = exports.useSyncState = exports.useStopSync = exports.useStartSync = exports.useSingleProject = exports.useSingleMember = exports.useSetAutostopDataSyncTimeout = exports.useRemoveMember = exports.useRemoveServerPeer = exports.useProjectSettings = exports.useProjectOwnRoleChangeListener = exports.useOwnRoleInProject = exports.useManyProjects = exports.useManyMembers = exports.useLeaveProject = exports.useImportProjectConfig = exports.useImportProjectCategories = exports.useIconUrl = exports.useDocumentCreatedBy = exports.useDisconnectSyncServers = exports.useDataSyncProgress = exports.useCreateProject = exports.useCreateBlob = exports.useConnectSyncServers = exports.useAttachmentUrl = exports.useAddServerPeer = exports.useMapStyleUrl = exports.useSingleInvite = exports.useSetUpInvitesListeners = exports.useSendInvite = exports.useRequestCancelInvite = exports.useRejectInvite = exports.useManyInvites = exports.useAcceptInvite = exports.useUpdateDocument = exports.useSingleDocByVersionId = exports.useSingleDocByDocId = exports.usePresetsSelection = exports.useManyDocs = exports.useDeleteDocument = exports.useCreateDocument = exports.useSetOwnDeviceInfo = exports.useSetIsArchiveDevice = exports.useOwnDeviceInfo = exports.useIsArchiveDevice = exports.useClientApi = exports.ClientApiProvider = exports.ClientApiContext = void 0;
-exports.useExportZipFile = void 0;
+exports.useExportZipFile = exports.useExportGeoJSON = exports.useChangeMemberRole = exports.useUpdateProjectSettings = exports.useSyncState = exports.useStopSync = exports.useStartSync = exports.useSingleProject = exports.useSingleMember = exports.useSetAutostopDataSyncTimeout = exports.useRemoveMember = exports.useRemoveServerPeer = exports.useProjectSettings = exports.useProjectOwnRoleChangeListener = exports.useOwnRoleInProject = exports.useManyProjects = exports.useManyMembers = exports.useLeaveProject = exports.useImportProjectConfig = exports.useImportProjectCategories = exports.useIconUrl = exports.useDocumentCreatedBy = exports.useDisconnectSyncServers = exports.useDataSyncProgress = exports.useCreateProject = exports.useCreateBlob = exports.useConnectSyncServers = exports.useAttachmentUrl = exports.useAddServerPeer = exports.useMapStyleUrl = exports.useSingleInvite = exports.useSendInvite = exports.useRequestCancelInvite = exports.useRejectInvite = exports.useManyInvites = exports.useAcceptInvite = exports.useUpdateDocument = exports.useSingleDocByVersionId = exports.useSingleDocByDocId = exports.usePresetsSelection = exports.useManyDocs = exports.useDeleteDocument = exports.useCreateDocument = exports.useSetOwnDeviceInfo = exports.useSetIsArchiveDevice = exports.useOwnDeviceInfo = exports.useIsArchiveDevice = exports.useClientApi = exports.ClientApiProvider = 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; } });
 var client_js_1 = require("./hooks/client.js");
 Object.defineProperty(exports, "useClientApi", { enumerable: true, get: function () { return client_js_1.useClientApi; } });
@@ -25,7 +23,6 @@ Object.defineProperty(exports, "useManyInvites", { enumerable: true, get: functi
 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, "useSetUpInvitesListeners", { enumerable: true, get: function () { return invites_js_1.useSetUpInvitesListeners; } });
 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; } });

package/dist/commonjs/lib/presets.d.ts

@@ -1,2 +1,4 @@
-import type { Preset } from '@comapeo/schema' with { 'resolution-mode': 'import' };
+import type { Preset } from '@comapeo/schema' with {
+    'resolution-mode': 'import'
+};
 export declare function getPresetsSelection(presets: Array<Preset>, orderedPresetIds?: Array<string>): Array<Preset>;

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

@@ -1,5 +1,9 @@
-import type { MapeoClientApi } from '@comapeo/ipc' with { 'resolution-mode': 'import' };
-import type { DeviceInfo } from '@comapeo/schema' with { 'resolution-mode': 'import' };
+import type { MapeoClientApi } from '@comapeo/ipc' with {
+    'resolution-mode': 'import'
+};
+import type { DeviceInfo } from '@comapeo/schema' with {
+    'resolution-mode': 'import'
+};
 import { type QueryClient } from '@tanstack/react-query';
 export declare function getClientQueryKey(): readonly ["@comapeo/core-react", "client"];
 export declare function getDeviceInfoQueryKey(): readonly ["@comapeo/core-react", "client", "device_info"];

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

@@ -1,7 +1,11 @@
-import type { DerivedDocFields } from '@comapeo/core/dist/datatype/index.js' with { 'resolution-mode': 'import' };
-import type { MapeoProjectApi } from '@comapeo/ipc' with { 'resolution-mode': 'import' };
+import type { DerivedDocFields } from '@comapeo/core/dist/datatype/index.js' with {
+    'resolution-mode': 'import'
+};
+import type { MapeoProjectApi } from '@comapeo/ipc' with {
+    'resolution-mode': 'import'
+};
 import { type QueryClient } from '@tanstack/react-query';
-import { WriteableDocument, WriteableDocumentType, WriteableValue } from '../types.js';
+import type { WriteableDocument, WriteableDocumentType, WriteableValue } from '../types.js';
 export declare function getDocumentsQueryKey<D extends WriteableDocumentType>({ projectId, docType, }: {
     projectId: string;
     docType: D;

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

@@ -1,5 +1,9 @@
-import type { MemberApi } from '@comapeo/core' with { 'resolution-mode': 'import' };
-import type { MapeoClientApi, MapeoProjectApi } from '@comapeo/ipc' with { 'resolution-mode': 'import' };
+import type { MemberApi } from '@comapeo/core' with {
+    'resolution-mode': 'import'
+};
+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 getInvitesByIdQueryKey({ inviteId }: {

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

@@ -1,4 +1,6 @@
-import type { MapeoClientApi } from '@comapeo/ipc' with { 'resolution-mode': 'import' };
+import type { MapeoClientApi } from '@comapeo/ipc' with {
+    'resolution-mode': 'import'
+};
 export declare function getMapsQueryKey(): readonly ["@comapeo/core-react", "maps"];
 export declare function getStyleJsonUrlQueryKey({ refreshToken, }: {
     refreshToken?: string;

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

@@ -1,5 +1,7 @@
 import type { BlobApi, MemberApi } from '@comapeo/core' with { 'resolution-mode': 'import' };
-import type { MapeoClientApi, MapeoProjectApi } from '@comapeo/ipc' with { 'resolution-mode': 'import' };
+import type { MapeoClientApi, MapeoProjectApi } from '@comapeo/ipc' with {
+    'resolution-mode': 'import'
+};
 import { type QueryClient, type UnusedSkipTokenOptions } from '@tanstack/react-query';
 export declare function getProjectsQueryKey(): readonly ["@comapeo/core-react", "projects"];
 export declare function getProjectByIdQueryKey({ projectId }: {
@@ -150,6 +152,8 @@ export declare function createProjectMutationOptions({ clientApi, queryClient, }
     mutationFn: (opts: {
         name?: string;
         configPath?: string;
+        projectColor?: string;
+        projectDescription?: string;
     } | undefined) => Promise<string>;
     onSuccess: () => void;
     networkMode: "always";

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

@@ -197,12 +197,7 @@ function createProjectMutationOptions({ clientApi, queryClient, }) {
         mutationFn: async (opts) => {
             // Have to avoid passing `undefined` explicitly
             // See https://github.com/digidem/rpc-reflector/issues/21
-            return opts
-                ? clientApi.createProject({
-                    configPath: opts.configPath,
-                    name: opts.name,
-                })
-                : clientApi.createProject();
+            return opts ? clientApi.createProject(opts) : clientApi.createProject();
         },
         onSuccess: () => {
             queryClient.invalidateQueries({

package/dist/commonjs/lib/sync.d.ts

@@ -1,4 +1,6 @@
-import type { MapeoProjectApi } from '@comapeo/ipc' with { 'resolution-mode': 'import' };
+import type { MapeoProjectApi } from '@comapeo/ipc' with {
+    'resolution-mode': 'import'
+};
 export type SyncState = Awaited<ReturnType<MapeoProjectApi['$sync']['getState']>>;
 export declare function getDataSyncCountForDevice(syncStateForDevice: SyncState['remoteDeviceSyncState'][string]): number;
 export declare class SyncStore {

package/dist/commonjs/lib/types.d.ts

@@ -1,4 +1,6 @@
-import type { MapeoDoc, MapeoValue } from '@comapeo/schema' with { 'resolution-mode': 'import' };
+import type { MapeoDoc, MapeoValue } from '@comapeo/schema' with {
+    'resolution-mode': 'import'
+};
 export type WriteableDocumentType = Extract<MapeoDoc['schemaName'], 'field' | 'observation' | 'preset' | 'track' | 'remoteDetectionAlert'>;
 export type WriteableValue<D extends WriteableDocumentType> = Extract<MapeoValue, {
     schemaName: D;

package/dist/esm/contexts/ClientApi.d.ts

@@ -1,4 +1,6 @@
-import type { MapeoClientApi } from '@comapeo/ipc' with { 'resolution-mode': 'import' };
+import type { MapeoClientApi } from '@comapeo/ipc' with {
+    'resolution-mode': 'import'
+};
 import { type Context, type JSX, type ReactNode } from 'react';
 export declare const ClientApiContext: Context<MapeoClientApi | null>;
 /**

package/dist/esm/contexts/ClientApi.js

@@ -1,4 +1,6 @@
-import { createContext, createElement, } from 'react';
+import { useQueryClient } from '@tanstack/react-query';
+import { createContext, createElement, useEffect, } from 'react';
+import { getInvitesQueryKey } from '../lib/react-query/invites.js';
 export const ClientApiContext = createContext(null);
 /**
  * Create a context provider that holds a CoMapeo API client instance.
@@ -8,5 +10,17 @@ export const ClientApiContext = createContext(null);
  *
  */
 export function ClientApiProvider({ children, clientApi, }) {
+    const queryClient = useQueryClient();
+    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]);
     return createElement(ClientApiContext.Provider, { value: clientApi }, children);
 }

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

@@ -1,4 +1,6 @@
-import type { MapeoClientApi } from '@comapeo/ipc' with { 'resolution-mode': 'import' };
+import type { MapeoClientApi } from '@comapeo/ipc' with {
+    'resolution-mode': 'import'
+};
 /**
  * Access a client API instance. If a ClientApiContext provider is not
  * set up, it will throw an error.

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

@@ -1,4 +1,6 @@
-import type { Preset } from '@comapeo/schema' with { 'resolution-mode': 'import' };
+import type { Preset } from '@comapeo/schema' with {
+    'resolution-mode': 'import'
+};
 import type { WriteableDocumentType } from '../lib/types.js';
 /**
  * Retrieve a single document from the database based on the document's document ID.

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

@@ -1,19 +1,3 @@
-/**
- * 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.
  *

package/dist/esm/hooks/invites.js

@@ -1,38 +1,7 @@
 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 { acceptInviteMutationOptions, getInviteByIdQueryOptions, 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.
  *

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

@@ -1,5 +1,12 @@
-import type { BlobApi, IconApi } from '@comapeo/core' with { 'resolution-mode': 'import' };
-import type { MapeoProjectApi } from '@comapeo/ipc' with { 'resolution-mode': 'import' };
+import type { BlobApi, IconApi } from '@comapeo/core' with {
+    'resolution-mode': 'import'
+};
+import type { RoleChangeEvent } from '@comapeo/core/dist/mapeo-project.js' with {
+    'resolution-mode': 'import'
+};
+import type { MapeoProjectApi } from '@comapeo/ipc' with {
+    'resolution-mode': 'import'
+};
 import { type SyncState } from '../lib/sync.js';
 /**
  * Retrieve the project settings for a project.
@@ -318,10 +325,14 @@ export declare function useCreateProject(): {
     mutate: import("@tanstack/react-query").UseMutateFunction<string, Error, {
         name?: string;
         configPath?: string;
+        projectColor?: string;
+        projectDescription?: string;
     } | undefined, unknown>;
     mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<string, Error, {
         name?: string;
         configPath?: string;
+        projectColor?: string;
+        projectDescription?: string;
     } | undefined, unknown>;
     reset: () => void;
     status: "error";
@@ -330,10 +341,14 @@ export declare function useCreateProject(): {
     mutate: import("@tanstack/react-query").UseMutateFunction<string, Error, {
         name?: string;
         configPath?: string;
+        projectColor?: string;
+        projectDescription?: string;
     } | undefined, unknown>;
     mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<string, Error, {
         name?: string;
         configPath?: string;
+        projectColor?: string;
+        projectDescription?: string;
     } | undefined, unknown>;
     reset: () => void;
     status: "pending" | "success" | "idle";
@@ -531,15 +546,31 @@ export declare function useRemoveMember({ projectId }: {
  * It is necessary to use this if you want the project role-related read hooks to update
  * based on role change events that are received in the background.
  *
+ * @param opts.listener Optional listener to invoke when role changes
+ *
  * @example
  * ```tsx
  * function SomeComponent({ projectId }: { projectId: string }) {
  *   useProjectOwnRoleChangeListener({ projectId })
  * }
  * ```
+ *
+ * @example
+ * ```tsx
+ * function ComponentWithListener({ projectId }: { projectId: string }) {
+ *   useProjectOwnRoleChangeListener({
+ *     projectId,
+ *     listener: (event) => {
+ *       // Handle role change, e.g., navigate to default project
+ *       console.log('New role:', event.role)
+ *     }
+ *   })
+ * }
+ * ```
  */
-export declare function useProjectOwnRoleChangeListener({ projectId, }: {
+export declare function useProjectOwnRoleChangeListener({ projectId, listener, }: {
     projectId: string;
+    listener?: (event: RoleChangeEvent) => void;
 }): void;
 /**
  * Create a blob for a project.

package/dist/esm/hooks/projects.js

@@ -415,14 +415,29 @@ export function useRemoveMember({ projectId }) {
  * It is necessary to use this if you want the project role-related read hooks to update
  * based on role change events that are received in the background.
  *
+ * @param opts.listener Optional listener to invoke when role changes
+ *
  * @example
  * ```tsx
  * function SomeComponent({ projectId }: { projectId: string }) {
  *   useProjectOwnRoleChangeListener({ projectId })
  * }
  * ```
+ *
+ * @example
+ * ```tsx
+ * function ComponentWithListener({ projectId }: { projectId: string }) {
+ *   useProjectOwnRoleChangeListener({
+ *     projectId,
+ *     listener: (event) => {
+ *       // Handle role change, e.g., navigate to default project
+ *       console.log('New role:', event.role)
+ *     }
+ *   })
+ * }
+ * ```
  */
-export function useProjectOwnRoleChangeListener({ projectId, }) {
+export function useProjectOwnRoleChangeListener({ projectId, listener, }) {
     const queryClient = useQueryClient();
     const { data: projectApi } = useSingleProject({ projectId });
     useEffect(() => {
@@ -439,6 +454,16 @@ export function useProjectOwnRoleChangeListener({ projectId, }) {
             projectApi.removeListener('own-role-change', invalidateCache);
         };
     }, [projectApi, queryClient, projectId]);
+    useEffect(() => {
+        if (listener) {
+            projectApi.addListener('own-role-change', listener);
+        }
+        return () => {
+            if (listener) {
+                projectApi.removeListener('own-role-change', listener);
+            }
+        };
+    }, [projectApi, listener]);
 }
 /**
  * Create a blob for a project.

package/dist/esm/index.d.ts

@@ -1,7 +1,7 @@
-export { ClientApiContext, ClientApiProvider } from './contexts/ClientApi.js';
+export { ClientApiProvider } from './contexts/ClientApi.js';
 export { useClientApi, useIsArchiveDevice, useOwnDeviceInfo, useSetIsArchiveDevice, useSetOwnDeviceInfo, } from './hooks/client.js';
 export { useCreateDocument, useDeleteDocument, useManyDocs, usePresetsSelection, useSingleDocByDocId, useSingleDocByVersionId, useUpdateDocument, } from './hooks/documents.js';
-export { useAcceptInvite, useManyInvites, useRejectInvite, useRequestCancelInvite, useSendInvite, useSetUpInvitesListeners, useSingleInvite, } from './hooks/invites.js';
+export { useAcceptInvite, useManyInvites, useRejectInvite, useRequestCancelInvite, useSendInvite, useSingleInvite, } from './hooks/invites.js';
 export { useMapStyleUrl } from './hooks/maps.js';
 export { useAddServerPeer, useAttachmentUrl, useConnectSyncServers, useCreateBlob, useCreateProject, useDataSyncProgress, useDisconnectSyncServers, useDocumentCreatedBy, useIconUrl, useImportProjectCategories, useImportProjectConfig, useLeaveProject, useManyMembers, useManyProjects, useOwnRoleInProject, useProjectOwnRoleChangeListener, useProjectSettings, useRemoveServerPeer, useRemoveMember, useSetAutostopDataSyncTimeout, useSingleMember, useSingleProject, useStartSync, useStopSync, useSyncState, useUpdateProjectSettings, useChangeMemberRole, useExportGeoJSON, useExportZipFile, } 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 { ClientApiProvider } from './contexts/ClientApi.js';
 export { useClientApi, useIsArchiveDevice, useOwnDeviceInfo, useSetIsArchiveDevice, useSetOwnDeviceInfo, } from './hooks/client.js';
 export { useCreateDocument, useDeleteDocument, useManyDocs, usePresetsSelection, useSingleDocByDocId, useSingleDocByVersionId, useUpdateDocument, } from './hooks/documents.js';
-export { useAcceptInvite, useManyInvites, useRejectInvite, useRequestCancelInvite, useSendInvite, useSetUpInvitesListeners, useSingleInvite, } from './hooks/invites.js';
+export { useAcceptInvite, useManyInvites, useRejectInvite, useRequestCancelInvite, useSendInvite, useSingleInvite, } from './hooks/invites.js';
 export { useMapStyleUrl } from './hooks/maps.js';
 export { useAddServerPeer, useAttachmentUrl, useConnectSyncServers, useCreateBlob, useCreateProject, useDataSyncProgress, useDisconnectSyncServers, useDocumentCreatedBy, useIconUrl, useImportProjectCategories, useImportProjectConfig, useLeaveProject, useManyMembers, useManyProjects, useOwnRoleInProject, useProjectOwnRoleChangeListener, useProjectSettings, useRemoveServerPeer, useRemoveMember, useSetAutostopDataSyncTimeout, useSingleMember, useSingleProject, useStartSync, useStopSync, useSyncState, useUpdateProjectSettings, useChangeMemberRole, useExportGeoJSON, useExportZipFile, } from './hooks/projects.js';

package/dist/esm/lib/presets.d.ts

@@ -1,2 +1,4 @@
-import type { Preset } from '@comapeo/schema' with { 'resolution-mode': 'import' };
+import type { Preset } from '@comapeo/schema' with {
+    'resolution-mode': 'import'
+};
 export declare function getPresetsSelection(presets: Array<Preset>, orderedPresetIds?: Array<string>): Array<Preset>;

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

@@ -1,5 +1,9 @@
-import type { MapeoClientApi } from '@comapeo/ipc' with { 'resolution-mode': 'import' };
-import type { DeviceInfo } from '@comapeo/schema' with { 'resolution-mode': 'import' };
+import type { MapeoClientApi } from '@comapeo/ipc' with {
+    'resolution-mode': 'import'
+};
+import type { DeviceInfo } from '@comapeo/schema' with {
+    'resolution-mode': 'import'
+};
 import { type QueryClient } from '@tanstack/react-query';
 export declare function getClientQueryKey(): readonly ["@comapeo/core-react", "client"];
 export declare function getDeviceInfoQueryKey(): readonly ["@comapeo/core-react", "client", "device_info"];

package/dist/esm/lib/react-query/documents.d.ts

@@ -1,7 +1,11 @@
-import type { DerivedDocFields } from '@comapeo/core/dist/datatype/index.js' with { 'resolution-mode': 'import' };
-import type { MapeoProjectApi } from '@comapeo/ipc' with { 'resolution-mode': 'import' };
+import type { DerivedDocFields } from '@comapeo/core/dist/datatype/index.js' with {
+    'resolution-mode': 'import'
+};
+import type { MapeoProjectApi } from '@comapeo/ipc' with {
+    'resolution-mode': 'import'
+};
 import { type QueryClient } from '@tanstack/react-query';
-import { WriteableDocument, WriteableDocumentType, WriteableValue } from '../types.js';
+import type { WriteableDocument, WriteableDocumentType, WriteableValue } from '../types.js';
 export declare function getDocumentsQueryKey<D extends WriteableDocumentType>({ projectId, docType, }: {
     projectId: string;
     docType: D;

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

@@ -1,5 +1,9 @@
-import type { MemberApi } from '@comapeo/core' with { 'resolution-mode': 'import' };
-import type { MapeoClientApi, MapeoProjectApi } from '@comapeo/ipc' with { 'resolution-mode': 'import' };
+import type { MemberApi } from '@comapeo/core' with {
+    'resolution-mode': 'import'
+};
+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 getInvitesByIdQueryKey({ inviteId }: {

package/dist/esm/lib/react-query/maps.d.ts

@@ -1,4 +1,6 @@
-import type { MapeoClientApi } from '@comapeo/ipc' with { 'resolution-mode': 'import' };
+import type { MapeoClientApi } from '@comapeo/ipc' with {
+    'resolution-mode': 'import'
+};
 export declare function getMapsQueryKey(): readonly ["@comapeo/core-react", "maps"];
 export declare function getStyleJsonUrlQueryKey({ refreshToken, }: {
     refreshToken?: string;

package/dist/esm/lib/react-query/projects.d.ts

@@ -1,5 +1,7 @@
 import type { BlobApi, MemberApi } from '@comapeo/core' with { 'resolution-mode': 'import' };
-import type { MapeoClientApi, MapeoProjectApi } from '@comapeo/ipc' with { 'resolution-mode': 'import' };
+import type { MapeoClientApi, MapeoProjectApi } from '@comapeo/ipc' with {
+    'resolution-mode': 'import'
+};
 import { type QueryClient, type UnusedSkipTokenOptions } from '@tanstack/react-query';
 export declare function getProjectsQueryKey(): readonly ["@comapeo/core-react", "projects"];
 export declare function getProjectByIdQueryKey({ projectId }: {
@@ -150,6 +152,8 @@ export declare function createProjectMutationOptions({ clientApi, queryClient, }
     mutationFn: (opts: {
         name?: string;
         configPath?: string;
+        projectColor?: string;
+        projectDescription?: string;
     } | undefined) => Promise<string>;
     onSuccess: () => void;
     networkMode: "always";

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

@@ -162,12 +162,7 @@ export function createProjectMutationOptions({ clientApi, queryClient, }) {
         mutationFn: async (opts) => {
             // Have to avoid passing `undefined` explicitly
             // See https://github.com/digidem/rpc-reflector/issues/21
-            return opts
-                ? clientApi.createProject({
-                    configPath: opts.configPath,
-                    name: opts.name,
-                })
-                : clientApi.createProject();
+            return opts ? clientApi.createProject(opts) : clientApi.createProject();
         },
         onSuccess: () => {
             queryClient.invalidateQueries({

package/dist/esm/lib/sync.d.ts

@@ -1,4 +1,6 @@
-import type { MapeoProjectApi } from '@comapeo/ipc' with { 'resolution-mode': 'import' };
+import type { MapeoProjectApi } from '@comapeo/ipc' with {
+    'resolution-mode': 'import'
+};
 export type SyncState = Awaited<ReturnType<MapeoProjectApi['$sync']['getState']>>;
 export declare function getDataSyncCountForDevice(syncStateForDevice: SyncState['remoteDeviceSyncState'][string]): number;
 export declare class SyncStore {

package/dist/esm/lib/types.d.ts

@@ -1,4 +1,6 @@
-import type { MapeoDoc, MapeoValue } from '@comapeo/schema' with { 'resolution-mode': 'import' };
+import type { MapeoDoc, MapeoValue } from '@comapeo/schema' with {
+    'resolution-mode': 'import'
+};
 export type WriteableDocumentType = Extract<MapeoDoc['schemaName'], 'field' | 'observation' | 'preset' | 'track' | 'remoteDetectionAlert'>;
 export type WriteableValue<D extends WriteableDocumentType> = Extract<MapeoValue, {
     schemaName: D;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@comapeo/core-react",
-	"version": "7.1.0",
+	"version": "8.0.0",
 	"description": "React wrapper for working with @comapeo/core",
 	"repository": {
 		"type": "git",
@@ -57,47 +57,47 @@
 		"types": "tsc"
 	},
 	"peerDependencies": {
-		"@comapeo/core": "^5.1.1",
-		"@comapeo/ipc": "^6.0.0",
+		"@comapeo/core": "^5.2.1",
+		"@comapeo/ipc": "^6.0.2",
 		"@comapeo/schema": "*",
 		"@tanstack/react-query": "^5",
 		"react": "^18 || ^19"
 	},
 	"devDependencies": {
-		"@comapeo/core": "5.1.1",
-		"@comapeo/ipc": "6.0.0",
+		"@comapeo/core": "5.2.1",
+		"@comapeo/ipc": "6.0.2",
 		"@comapeo/schema": "2.2.0",
-		"@eslint/compat": "1.3.2",
-		"@eslint/js": "9.35.0",
+		"@eslint/compat": "2.0.0",
+		"@eslint/js": "9.39.2",
 		"@ianvs/prettier-plugin-sort-imports": "4.7.0",
 		"@mapeo/crypto": "1.0.0-alpha.10",
 		"@mapeo/default-config": "6.0.0",
 		"@mapeo/mock-data": "5.0.0",
-		"@tanstack/eslint-plugin-query": "5.89.0",
-		"@tanstack/react-query": "5.89.0",
+		"@tanstack/eslint-plugin-query": "5.91.2",
+		"@tanstack/react-query": "5.90.12",
 		"@testing-library/dom": "10.4.1",
-		"@testing-library/react": "16.3.0",
-		"@types/node": "22.18.6",
-		"@types/react": "19.1.13",
-		"@types/react-dom": "19.1.9",
-		"@vitest/eslint-plugin": "1.3.12",
-		"eslint": "9.35.0",
-		"eslint-plugin-react-hooks": "5.2.0",
-		"eslint-plugin-testing-library": "7.8.0",
+		"@testing-library/react": "16.3.1",
+		"@types/node": "22.19.3",
+		"@types/react": "19.2.7",
+		"@types/react-dom": "19.2.3",
+		"@vitest/eslint-plugin": "1.5.2",
+		"eslint": "9.39.2",
+		"eslint-plugin-react-hooks": "7.0.1",
+		"eslint-plugin-testing-library": "7.14.0",
 		"fastify": "4.29.1",
-		"globals": "16.4.0",
-		"happy-dom": "18.0.1",
+		"globals": "16.5.0",
+		"happy-dom": "20.0.11",
 		"husky": "9.1.7",
-		"lint-staged": "15.5.2",
-		"npm-run-all2": "7.0.2",
-		"prettier": "3.6.2",
+		"lint-staged": "16.2.7",
+		"npm-run-all2": "8.0.4",
+		"prettier": "3.7.4",
 		"random-access-memory": "6.2.1",
-		"react": "19.1.1",
-		"react-dom": "19.1.1",
+		"react": "19.2.3",
+		"react-dom": "19.2.3",
 		"tsdoc-markdown": "1.4.1",
-		"tshy": "3.0.2",
-		"typescript": "5.9.2",
-		"typescript-eslint": "8.44.0",
-		"vitest": "3.2.4"
+		"tshy": "3.1.0",
+		"typescript": "5.9.3",
+		"typescript-eslint": "8.49.0",
+		"vitest": "4.0.15"
 	}
 }