@comapeo/core-react 9.0.1 → 10.0.0

package/README.md

@@ -7,7 +7,7 @@ React wrapper for working with [`@comapeo/core`](https://github.com/digidem/coma
 `react`, `@tanstack/react-query`, `@comapeo/schema`, `@comapeo/core`, and `@comapeo/ipc` are peer deps and must be installed alongside this package. You may want to pin these to specific versions depending on your needs.
 
 ```sh
-npm install react @tanstack/react-query@5 @comapeo/core-react @comapeo/schema @comapeo/core @comapeo/ipc
+npm install react @tanstack/react-query@5 @comapeo/core-react @comapeo/core @comapeo/ipc
 ```
 
 ## Setup

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

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

package/dist/commonjs/contexts/ClientApi.js

@@ -4,7 +4,7 @@ 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");
+const react_query_js_1 = require("../lib/react-query.js");
 exports.ClientApiContext = (0, react_1.createContext)(null);
 /**
  * Create a context provider that holds a CoMapeo API client instance.
@@ -17,7 +17,7 @@ function ClientApiProvider({ children, clientApi, }) {
     const queryClient = (0, react_query_1.useQueryClient)();
     (0, react_1.useEffect)(() => {
         function invalidateInviteCache() {
-            queryClient.invalidateQueries({ queryKey: (0, invites_js_1.getInvitesQueryKey)() });
+            queryClient.invalidateQueries({ queryKey: (0, react_query_js_1.getInvitesQueryKey)() });
         }
         // Invite listeners
         clientApi.invite.addListener('invite-received', invalidateInviteCache);

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

@@ -1,6 +1,6 @@
-import type { MapeoClientApi } from '@comapeo/ipc' with {
-    'resolution-mode': 'import'
-};
+import type { DeviceInfo } from '@comapeo/core/schema.js';
+import type { MapeoClientApi } from '@comapeo/ipc';
+import { type UseSuspenseQueryResult } from '@tanstack/react-query';
 /**
  * Access a client API instance. If a ClientApiContext provider is not
  * set up, it will throw an error.
@@ -37,14 +37,7 @@ export declare function useClientApi(): MapeoClientApi;
  * }
  * ```
  */
-export declare function useOwnDeviceInfo(): {
-    data: {
-        deviceId: string;
-        deviceType: import("@comapeo/core/dist/schema/client.js", { with: { "resolution-mode": "import" } }).DeviceInfoParam["deviceType"];
-    } & Partial<import("@comapeo/core/dist/schema/client.js", { with: { "resolution-mode": "import" } }).DeviceInfoParam>;
-    error: Error | null;
-    isRefetching: boolean;
-};
+export declare function useOwnDeviceInfo(): Pick<UseSuspenseQueryResult<Awaited<ReturnType<MapeoClientApi['getDeviceInfo']>>>, 'data' | 'error' | 'isRefetching'>;
 /**
  * Retrieve whether the current device is an archive device or not.
  *
@@ -63,52 +56,100 @@ export declare function useIsArchiveDevice(): {
 /**
  * Update the device info for the current device.
  */
-export declare function useSetOwnDeviceInfo(): {
-    error: Error;
+export declare function useSetOwnDeviceInfo(): Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverIdleResult<void, Error, {
+    name: string;
+    deviceType: DeviceInfo["deviceType"];
+}, unknown>, {
     mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
         name: string;
-        deviceType: import("@comapeo/schema", { with: { "resolution-mode": "import" } }).DeviceInfo["deviceType"];
+        deviceType: DeviceInfo["deviceType"];
     }, unknown>;
+}> & {
     mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, {
         name: string;
-        deviceType: import("@comapeo/schema", { with: { "resolution-mode": "import" } }).DeviceInfo["deviceType"];
+        deviceType: DeviceInfo["deviceType"];
     }, unknown>;
-    reset: () => void;
-    status: "error";
-} | {
-    error: null;
+}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverLoadingResult<void, Error, {
+    name: string;
+    deviceType: DeviceInfo["deviceType"];
+}, unknown>, {
     mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
         name: string;
-        deviceType: import("@comapeo/schema", { with: { "resolution-mode": "import" } }).DeviceInfo["deviceType"];
+        deviceType: DeviceInfo["deviceType"];
     }, unknown>;
+}> & {
     mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, {
         name: string;
-        deviceType: import("@comapeo/schema", { with: { "resolution-mode": "import" } }).DeviceInfo["deviceType"];
+        deviceType: DeviceInfo["deviceType"];
     }, unknown>;
-    reset: () => void;
-    status: "pending" | "success" | "idle";
-};
+}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverErrorResult<void, Error, {
+    name: string;
+    deviceType: DeviceInfo["deviceType"];
+}, unknown>, {
+    mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
+        name: string;
+        deviceType: DeviceInfo["deviceType"];
+    }, unknown>;
+}> & {
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, {
+        name: string;
+        deviceType: DeviceInfo["deviceType"];
+    }, unknown>;
+}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverSuccessResult<void, Error, {
+    name: string;
+    deviceType: DeviceInfo["deviceType"];
+}, unknown>, {
+    mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
+        name: string;
+        deviceType: DeviceInfo["deviceType"];
+    }, unknown>;
+}> & {
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, {
+        name: string;
+        deviceType: DeviceInfo["deviceType"];
+    }, unknown>;
+}, "error" | "status" | "mutate" | "reset" | "mutateAsync">;
 /**
  * Set or unset the current device as an archive device.
  */
-export declare function useSetIsArchiveDevice(): {
-    error: Error;
+export declare function useSetIsArchiveDevice(): Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverIdleResult<void, Error, {
+    isArchiveDevice: boolean;
+}, unknown>, {
     mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
         isArchiveDevice: boolean;
     }, unknown>;
+}> & {
     mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, {
         isArchiveDevice: boolean;
     }, unknown>;
-    reset: () => void;
-    status: "error";
-} | {
-    error: null;
+}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverLoadingResult<void, Error, {
+    isArchiveDevice: boolean;
+}, unknown>, {
     mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
         isArchiveDevice: boolean;
     }, unknown>;
+}> & {
     mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, {
         isArchiveDevice: boolean;
     }, unknown>;
-    reset: () => void;
-    status: "pending" | "success" | "idle";
-};
+}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverErrorResult<void, Error, {
+    isArchiveDevice: boolean;
+}, unknown>, {
+    mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
+        isArchiveDevice: boolean;
+    }, unknown>;
+}> & {
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, {
+        isArchiveDevice: boolean;
+    }, unknown>;
+}, "error" | "status" | "mutate" | "reset" | "mutateAsync"> | Pick<import("@tanstack/react-query").Override<import("@tanstack/react-query").MutationObserverSuccessResult<void, Error, {
+    isArchiveDevice: boolean;
+}, unknown>, {
+    mutate: import("@tanstack/react-query").UseMutateFunction<void, Error, {
+        isArchiveDevice: boolean;
+    }, unknown>;
+}> & {
+    mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<void, Error, {
+        isArchiveDevice: boolean;
+    }, unknown>;
+}, "error" | "status" | "mutate" | "reset" | "mutateAsync">;

package/dist/commonjs/hooks/client.js

@@ -8,7 +8,7 @@ exports.useSetIsArchiveDevice = useSetIsArchiveDevice;
 const react_query_1 = require("@tanstack/react-query");
 const react_1 = require("react");
 const ClientApi_js_1 = require("../contexts/ClientApi.js");
-const client_js_1 = require("../lib/react-query/client.js");
+const react_query_js_1 = require("../lib/react-query.js");
 /**
  * Access a client API instance. If a ClientApiContext provider is not
  * set up, it will throw an error.
@@ -53,7 +53,13 @@ function useClientApi() {
  */
 function useOwnDeviceInfo() {
     const clientApi = useClientApi();
-    const { data, error, isRefetching } = (0, react_query_1.useSuspenseQuery)((0, client_js_1.deviceInfoQueryOptions)({ clientApi }));
+    const { data, error, isRefetching } = (0, react_query_1.useSuspenseQuery)({
+        ...(0, react_query_js_1.baseQueryOptions)(),
+        queryKey: (0, react_query_js_1.getDeviceInfoQueryKey)(),
+        queryFn: async () => {
+            return clientApi.getDeviceInfo();
+        },
+    });
     return { data, error, isRefetching };
 }
 /**
@@ -68,7 +74,13 @@ function useOwnDeviceInfo() {
  */
 function useIsArchiveDevice() {
     const clientApi = useClientApi();
-    const { data, error, isRefetching } = (0, react_query_1.useSuspenseQuery)((0, client_js_1.isArchiveDeviceQueryOptions)({ clientApi }));
+    const { data, error, isRefetching } = (0, react_query_1.useSuspenseQuery)({
+        ...(0, react_query_js_1.baseQueryOptions)(),
+        queryKey: (0, react_query_js_1.getIsArchiveDeviceQueryKey)(),
+        queryFn: async () => {
+            return clientApi.getIsArchiveDevice();
+        },
+    });
     return { data, error, isRefetching };
 }
 /**
@@ -77,10 +89,20 @@ function useIsArchiveDevice() {
 function useSetOwnDeviceInfo() {
     const queryClient = (0, react_query_1.useQueryClient)();
     const clientApi = useClientApi();
-    const { error, mutate, mutateAsync, reset, status } = (0, react_query_1.useMutation)((0, client_js_1.setOwnDeviceInfoMutationOptions)({ clientApi, queryClient }));
-    return status === 'error'
-        ? { error, mutate, mutateAsync, reset, status }
-        : { error: null, mutate, mutateAsync, reset, status };
+    return (0, react_query_js_1.filterMutationResult)((0, react_query_1.useMutation)({
+        ...(0, react_query_js_1.baseMutationOptions)(),
+        mutationFn: async ({ name, deviceType, }) => {
+            return clientApi.setDeviceInfo({ name, deviceType });
+        },
+        onSuccess: () => {
+            queryClient.invalidateQueries({
+                queryKey: (0, react_query_js_1.getDeviceInfoQueryKey)(),
+            });
+            queryClient.invalidateQueries({
+                queryKey: (0, react_query_js_1.getProjectsQueryKey)(),
+            });
+        },
+    }));
 }
 /**
  * Set or unset the current device as an archive device.
@@ -88,8 +110,15 @@ function useSetOwnDeviceInfo() {
 function useSetIsArchiveDevice() {
     const queryClient = (0, react_query_1.useQueryClient)();
     const clientApi = useClientApi();
-    const { error, mutate, mutateAsync, status, reset } = (0, react_query_1.useMutation)((0, client_js_1.setIsArchiveDeviceMutationOptions)({ clientApi, queryClient }));
-    return status === 'error'
-        ? { error, mutate, mutateAsync, reset, status }
-        : { error: null, mutate, mutateAsync, reset, status };
+    return (0, react_query_js_1.filterMutationResult)((0, react_query_1.useMutation)({
+        ...(0, react_query_js_1.baseMutationOptions)(),
+        mutationFn: async ({ isArchiveDevice }) => {
+            return clientApi.setIsArchiveDevice(isArchiveDevice);
+        },
+        onSuccess: () => {
+            queryClient.invalidateQueries({
+                queryKey: (0, react_query_js_1.getIsArchiveDeviceQueryKey)(),
+            });
+        },
+    }));
 }