@pol-studios/db 1.0.0 → 1.0.1

package/dist/realtime/index.d.ts

@@ -0,0 +1,44 @@
+import { RealtimePostgresChangesPayload, PostgrestSingleResponse } from '@supabase/supabase-js';
+import { ItemType } from '@pol-studios/utils';
+import { UseQueryOptions } from '@tanstack/react-query';
+import { U as UseDbQuerySingleReturn } from '../useDbQuery-C-TL8jY1.js';
+import '@supabase-cache-helpers/postgrest-react-query';
+
+declare function useRealtime(key: string, query: string, table: string | {
+    table: string;
+    schema: string;
+}, primaryKeys: string[], options?: {
+    filter?: string;
+    enabled?: boolean;
+    onChange?: (payload: RealtimePostgresChangesPayload<{
+        [key: string]: any;
+    }>) => any;
+}): "SUBSCRIBED" | "TIMED_OUT" | "CLOSED" | "CHANNEL_ERROR";
+
+type ConfigurationOptions<T> = {
+    crossOrganization?: boolean;
+};
+type FilterOperator = "or" | "eq" | "neq" | "gt" | "gte" | "lt" | "lte" | "like" | "ilike" | "is" | "in" | "cs" | "cd" | "fts" | "plfts";
+type ValueType = number | string | boolean | null | Date | object;
+type FilterDefinition = {
+    path: string;
+    alias?: string;
+    operator: FilterOperator;
+    negate: boolean;
+    value: ValueType;
+};
+type FilterDefinitions = (FilterComposite | FilterDefinition)[];
+type FilterComposite = {
+    or?: FilterDefinitions;
+    and?: FilterDefinitions;
+};
+type UseRealtimeQueryResult<T> = UseDbQuerySingleReturn<T> & {
+    realtimeStatus: "SUBSCRIBED" | "TIMED_OUT" | "CLOSED" | "CHANNEL_ERROR" | "Loading...";
+    isRealtimeConnected: boolean;
+    isRealtimeLoading: boolean;
+};
+type DataType = Record<string, any>;
+declare function convertFilterToRealtimeQuery(filters: FilterDefinitions): string;
+declare function useRealtimeQuery<Result extends DataType>(query: PromiseLike<PostgrestSingleResponse<Result>>, config?: Omit<UseQueryOptions<PostgrestSingleResponse<Result>>, "queryKey" | "queryFn"> & ConfigurationOptions<Result>, primaryKeys?: (keyof ItemType<Result> & string)[]): UseRealtimeQueryResult<Result>;
+
+export { type UseRealtimeQueryResult, convertFilterToRealtimeQuery, useRealtimeQuery as useDbRealtimeQuery, useRealtime, useRealtimeQuery };