@pol-studios/db 1.0.0 → 1.0.2

package/dist/hooks/index.d.ts

@@ -0,0 +1,83 @@
+export { H as ClarificationQuestion, p as DatabaseTypes, F as Filter, y as FilterGroup, z as FilterOperator, E as Pagination, P as PublicTableNames, Q as QueryState, R as ResolveRowType, S as SchemaNames, q as SchemaTableNames, G as Sort, r as TableIdentifier, I as UseAdvanceQueryOptions, J as UseAdvanceQueryResult, a4 as UseDbCountOptions, a5 as UseDbCountResult, _ as UseDbDeleteOptions, $ as UseDbDeleteResult, a1 as UseDbInfiniteQueryOptions, a2 as UseDbInfiniteQueryResult, L as UseDbInsertOptions, M as UseDbInsertResult, v as UseDbQueryByIdOptions, w as UseDbQueryByIdResult, U as UseDbQueryOptions, s as UseDbQueryResult, O as UseDbUpdateOptions, V as UseDbUpdateResult, X as UseDbUpsertOptions, Y as UseDbUpsertResult, x as useAdvanceQuery, u as useDataLayer, n as useDataLayerOptional, a3 as useDbCount, Z as useDbDelete, a0 as useDbInfiniteQuery, K as useDbInsert, o as useDbQuery, t as useDbQueryById, N as useDbUpdate, W as useDbUpsert } from '../useDbCount-B5-Va9sg.js';
+import { SyncStatus, SyncControl } from '../core/index.js';
+import 'react';
+import '@supabase/supabase-js';
+import '@tanstack/react-query';
+import '../executor-CB4KHyYG.js';
+
+/**
+ * V3 useSyncStatus Hook
+ *
+ * Provides sync status information from the data layer.
+ * Returns default "always synced" status when PowerSync is not available.
+ */
+
+/**
+ * Hook to get the current sync status
+ *
+ * When PowerSync is not available, returns a default "always synced" status.
+ *
+ * @example
+ * const { isSyncing, pendingUploads, isConnected } = useSyncStatus();
+ *
+ * if (pendingUploads > 0) {
+ *   console.log(`${pendingUploads} changes waiting to sync`);
+ * }
+ */
+declare function useSyncStatus(): SyncStatus;
+
+/**
+ * V3 useSyncControl Hook
+ *
+ * Provides sync control functions from the data layer.
+ * Returns no-op functions when PowerSync is not available.
+ */
+
+/**
+ * Hook to get sync controls for PowerSync
+ *
+ * When PowerSync is not available, all methods are no-ops that log a warning.
+ *
+ * @example
+ * const { triggerSync, startLiveSync, stopLiveSync } = useSyncControl();
+ *
+ * // Manually trigger a sync
+ * await triggerSync();
+ *
+ * // Start/stop live sync
+ * await startLiveSync();
+ * stopLiveSync();
+ */
+declare function useSyncControl(): SyncControl;
+
+/**
+ * V3 useOnlineStatus Hook
+ *
+ * Provides online/connection status information.
+ * Combines data layer status with platform-specific online/offline events.
+ * Works on both web (browser events) and React Native (NetInfo).
+ */
+/**
+ * Online status information
+ */
+interface OnlineStatus {
+    /** Whether the device has network connectivity */
+    isOnline: boolean;
+    /** Whether PowerSync is connected (false if using Supabase-only) */
+    isConnected: boolean;
+    /** Current backend being used */
+    backend: "powersync" | "supabase" | null;
+}
+/**
+ * Hook to get online/connection status
+ *
+ * @example
+ * const { isOnline, isConnected, backend } = useOnlineStatus();
+ *
+ * if (!isOnline) {
+ *   return <OfflineBanner />;
+ * }
+ */
+declare function useOnlineStatus(): OnlineStatus;
+
+export { type OnlineStatus, useOnlineStatus, useSyncControl, useSyncStatus };