Skip to main content

Interface: SiteSyncActions

Defined in: src/stores/sites/useSiteSync.ts:56

Site synchronization actions interface.

Remarks​

Defines all available site synchronization operations that can be performed. These actions are designed to work within the Zustand store architecture and provide consistent error handling and logging.

Properties​

fullResyncSites()​

fullResyncSites: () => Promise<void>

Defined in: src/stores/sites/useSiteSync.ts:68

Performs complete resynchronization from the backend with full state replacement.

Returns​

Promise<void>

Promise that resolves when synchronization is complete

Remarks​

Triggers a comprehensive sync operation that replaces all local site data with authoritative information from the backend. This method provides complete data consistency and is used for recovery scenarios.

getSyncStatus()​

getSyncStatus: () => Promise<{ lastSyncAt?: number | null; siteCount: number; source: "cache" | "database" | "frontend"; synchronized: boolean; }>

Defined in: src/stores/sites/useSiteSync.ts:83

Retrieves current synchronization status from the backend.

Returns​

Promise<{ lastSyncAt?: number | null; siteCount: number; source: "cache" | "database" | "frontend"; synchronized: boolean; }>

Promise resolving to sync status information

Remarks​

Provides detailed information about the sync state including:

  • Last synchronization timestamp
  • Current site count
  • Origin of the synchronized data
  • Whether the renderer is in sync with the backend

retryStatusSubscription()​

retryStatusSubscription: (callback?: (update: StatusUpdate) => void) => Promise<StatusUpdateSubscriptionSummary>

Defined in: src/stores/sites/useSiteSync.ts:86

Retry status update subscription using the most recent callback

Parameters​

callback?​

(update: StatusUpdate) => void

Returns​

Promise<StatusUpdateSubscriptionSummary>

subscribeToStatusUpdates()​

subscribeToStatusUpdates: (callback?: (update: StatusUpdate) => void) => Promise<StatusUpdateSubscriptionSummary>

Defined in: src/stores/sites/useSiteSync.ts:105

Establishes subscription to real-time status updates.

Parameters​

callback?​

(update: StatusUpdate) => void

Function to call when status updates are received

Returns​

Promise<StatusUpdateSubscriptionSummary>

Subscription result with success indicators

Remarks​

Sets up event listeners for monitor status changes from the backend. Uses the shared StatusUpdateManager to handle:

  • Race condition prevention
  • Fallback mechanisms
  • Efficient incremental updates

subscribeToSyncEvents()​

subscribeToSyncEvents: () => () => void

Defined in: src/stores/sites/useSiteSync.ts:124

Establishes subscription to backend synchronization events.

Returns​

Cleanup function to remove event listeners

(): void

Returns​

void

Remarks​

Listens for various sync events including:

  • Bulk synchronization events
  • Individual site updates
  • Site deletions

Automatically handles different event types and triggers appropriate local state updates.

syncSites()​

syncSites: () => Promise<void>

Defined in: src/stores/sites/useSiteSync.ts:138

Synchronizes sites data with backend while preserving local state.

Returns​

Promise<void>

Promise that resolves when sync is complete

Remarks​

Fetches the latest site data from the backend and updates the local store state. Includes comprehensive error handling and logging for debugging purposes.

This is the core synchronization method used by other sync operations.

unsubscribeFromStatusUpdates()​

unsubscribeFromStatusUpdates: () => StatusUpdateUnsubscribeResult

Defined in: src/stores/sites/useSiteSync.ts:150

Removes subscription to status updates.

Returns​

StatusUpdateUnsubscribeResult

Unsubscription result with success indicators

Remarks​

Cleanly unsubscribes from status update events and releases associated resources. Should be called when components unmount or when status updates are no longer needed.