feat: introduce missing sync write hooks

Exposes useConnectSyncServers, useDisconnectSyncServers, and
useSetAutostopDataSyncTimeout.

Author: achou11

docs/API.md

@@ -26,6 +26,9 @@
 - [useDataSyncProgress](#usedatasyncprogress)
 - [useStartSync](#usestartsync)
 - [useStopSync](#usestopsync)
+- [useConnectSyncServers](#useconnectsyncservers)
+- [useDisconnectSyncServers](#usedisconnectsyncservers)
+- [useSetAutostopDataSyncTimeout](#usesetautostopdatasynctimeout)
 - [useSingleDocByDocId](#usesingledocbydocid)
 - [useSingleDocByVersionId](#usesingledocbyversionid)
 - [useManyDocs](#usemanydocs)
@@ -526,6 +529,24 @@ Provides the progress of data sync for sync-enabled connected peers
 | ---------- | ---------- |
 | `useStopSync` | `({ projectId }: { projectId: string; }) => { error: Error; mutate: UseMutateFunction<void, Error, void, unknown>; mutateAsync: UseMutateAsyncFunction<void, Error, void, unknown>; reset: () => void; status: "error"; } or { ...; }` |
 
+### useConnectSyncServers
+
+| Function | Type |
+| ---------- | ---------- |
+| `useConnectSyncServers` | `({ projectId }: { projectId: string; }) => { error: Error; mutate: UseMutateFunction<void, Error, void, unknown>; mutateAsync: UseMutateAsyncFunction<void, Error, void, unknown>; reset: () => void; status: "error"; } or { ...; }` |
+
+### useDisconnectSyncServers
+
+| Function | Type |
+| ---------- | ---------- |
+| `useDisconnectSyncServers` | `({ projectId }: { projectId: string; }) => { error: Error; mutate: UseMutateFunction<void, Error, void, unknown>; mutateAsync: UseMutateAsyncFunction<void, Error, void, unknown>; reset: () => void; status: "error"; } or { ...; }` |
+
+### useSetAutostopDataSyncTimeout
+
+| Function | Type |
+| ---------- | ---------- |
+| `useSetAutostopDataSyncTimeout` | `({ projectId, }: { projectId: string; }) => { error: Error; mutate: UseMutateFunction<void, Error, { after: number or null; }, unknown>; mutateAsync: UseMutateAsyncFunction<void, Error, { ...; }, unknown>; reset: () => void; status: "error"; } or { ...; }` |
+
 ### useSingleDocByDocId
 
 Retrieve a single document from the database based on the document's document ID.

src/hooks/projects.ts

@@ -14,8 +14,10 @@ import { useSyncExternalStore } from 'react'
 import {
 	addServerPeerMutationOptions,
 	attachmentUrlQueryOptions,
+	connectSyncServersMutationOptions,
 	createBlobMutationOptions,
 	createProjectMutationOptions,
+	disconnectSyncServersMutationOptions,
 	documentCreatedByQueryOptions,
 	iconUrlQueryOptions,
 	importProjectConfigMutationOptions,
@@ -27,6 +29,7 @@ import {
 	projectSettingsQueryOptions,
 	projectsQueryOptions,
 	removeServerPeerMutationOptions,
+	setAutostopDataSyncTimeoutMutationOptions,
 	startSyncMutationOptions,
 	stopSyncMutationOptions,
 	updateProjectSettingsMutationOptions,
@@ -567,3 +570,43 @@ export function useStopSync({ projectId }: { projectId: string }) {
 		? { error, mutate, mutateAsync, reset, status }
 		: { error: null, mutate, mutateAsync, reset, status }
 }
+
+export function useConnectSyncServers({ projectId }: { projectId: string }) {
+	const { data: projectApi } = useSingleProject({ projectId })
+
+	const { error, mutate, mutateAsync, reset, status } = useMutation(
+		connectSyncServersMutationOptions({ projectApi }),
+	)
+
+	return status === 'error'
+		? { error, mutate, mutateAsync, reset, status }
+		: { error: null, mutate, mutateAsync, reset, status }
+}
+
+export function useDisconnectSyncServers({ projectId }: { projectId: string }) {
+	const { data: projectApi } = useSingleProject({ projectId })
+
+	const { error, mutate, mutateAsync, reset, status } = useMutation(
+		disconnectSyncServersMutationOptions({ projectApi }),
+	)
+
+	return status === 'error'
+		? { error, mutate, mutateAsync, reset, status }
+		: { error: null, mutate, mutateAsync, reset, status }
+}
+
+export function useSetAutostopDataSyncTimeout({
+	projectId,
+}: {
+	projectId: string
+}) {
+	const { data: projectApi } = useSingleProject({ projectId })
+
+	const { error, mutate, mutateAsync, reset, status } = useMutation(
+		setAutostopDataSyncTimeoutMutationOptions({ projectApi }),
+	)
+
+	return status === 'error'
+		? { error, mutate, mutateAsync, reset, status }
+		: { error: null, mutate, mutateAsync, reset, status }
+}

src/index.ts

@@ -16,20 +16,22 @@ export {
 } from './hooks/documents.js'
 export {
 	useAcceptInvite,
-	useSetUpInvitesListeners,
 	useManyInvites,
 	useRejectInvite,
 	useRequestCancelInvite,
 	useSendInvite,
+	useSetUpInvitesListeners,
 	useSingleInvite,
 } from './hooks/invites.js'
 export { useMapStyleUrl } from './hooks/maps.js'
 export {
 	useAddServerPeer,
 	useAttachmentUrl,
+	useConnectSyncServers,
 	useCreateBlob,
 	useCreateProject,
 	useDataSyncProgress,
+	useDisconnectSyncServers,
 	useDocumentCreatedBy,
 	useIconUrl,
 	useImportProjectConfig,
@@ -39,6 +41,7 @@ export {
 	useOwnRoleInProject,
 	useProjectSettings,
 	useRemoveServerPeer,
+	useSetAutostopDataSyncTimeout,
 	useSingleMember,
 	useSingleProject,
 	useStartSync,

src/lib/react-query/projects.ts

@@ -476,3 +476,42 @@ export function stopSyncMutationOptions({
 		},
 	} satisfies UseMutationOptions<void, Error, void>
 }
+
+export function connectSyncServersMutationOptions({
+	projectApi,
+}: {
+	projectApi: MapeoProjectApi
+}) {
+	return {
+		...baseMutationOptions(),
+		mutationFn: async () => {
+			return projectApi.$sync.connectServers()
+		},
+	} satisfies UseMutationOptions<void, Error, void>
+}
+
+export function disconnectSyncServersMutationOptions({
+	projectApi,
+}: {
+	projectApi: MapeoProjectApi
+}) {
+	return {
+		...baseMutationOptions(),
+		mutationFn: async () => {
+			return projectApi.$sync.disconnectServers()
+		},
+	} satisfies UseMutationOptions<void, Error, void>
+}
+
+export function setAutostopDataSyncTimeoutMutationOptions({
+	projectApi,
+}: {
+	projectApi: MapeoProjectApi
+}) {
+	return {
+		...baseMutationOptions(),
+		mutationFn: async ({ after }) => {
+			return projectApi.$sync.setAutostopDataSyncTimeout(after)
+		},
+	} satisfies UseMutationOptions<void, Error, { after: number | null }>
+}