@comapeo/core-react 7.1.0 → 7.2.0

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

@@ -1,4 +1,5 @@
 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';
 /**
@@ -531,15 +532,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/esm/hooks/projects.d.ts

@@ -1,4 +1,5 @@
 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';
 /**
@@ -531,15 +532,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/package.json

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