@reifydb/react 0.9.1 → 0.9.3

package/dist/index.d.ts

@@ -1,231 +1,40 @@
-import { Column, ShapeNode, InferShape } from '@reifydb/core';
+import { ShapeNode, InferShape, FrameResults } from '@reifydb/core';
 export * from '@reifydb/core';
-import { WsClientOptions, WsClient, HttpClient, JsonHttpClient, JsonWsClient, SubscriptionConfig } from '@reifydb/client';
+import { SubscriptionConfig } from '@reifydb/client';
 export * from '@reifydb/client';
-import React, { ReactNode } from 'react';
+import { Store, Entry } from '@reifydb/store';
+export * from '@reifydb/store';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ReactNode } from 'react';
 
-interface ConnectionState {
-    client: WsClient | HttpClient | JsonHttpClient | JsonWsClient | null;
-    isConnected: boolean;
-    isConnecting: boolean;
-    connectionError: string | null;
-    listeners: Set<(state: ConnectionState) => void>;
+interface StoreProviderProps {
+    store: Store;
+    children?: ReactNode;
 }
-interface ConnectionConfig {
-    url?: string;
-    token?: string;
-    format?: 'json';
-    options?: Omit<WsClientOptions, 'url' | 'token'>;
-}
-declare const DEFAULT_CONFIG: ConnectionConfig;
-declare const DEFAULT_URL = "ws://127.0.0.1:8090";
-declare class Connection {
-    private state;
-    private config;
-    private connectPromise;
-    constructor(config?: ConnectionConfig);
-    setConfig(config: ConnectionConfig): void;
-    getConfig(): ConnectionConfig;
-    connect(url?: string, options?: Omit<WsClientOptions, 'url'>): Promise<void>;
-    disconnect(): Promise<void>;
-    reconnect(url?: string, options?: Omit<WsClientOptions, 'url'>): Promise<void>;
-    getClient(): WsClient | HttpClient | JsonHttpClient | JsonWsClient | null;
-    isConnected(): boolean;
-    isConnecting(): boolean;
-    getConnectionError(): string | null;
-    getState(): Omit<ConnectionState, 'listeners'>;
-    subscribe(listener: (state: ConnectionState) => void): () => void;
-    private updateState;
-}
-
-/**
- * Get the singleton connection instance.
- * If a config is provided, the connection's config will be updated via setConfig().
- * @param config - Optional connection configuration
- * @returns The singleton Connection instance
- */
-declare function getConnection(config?: ConnectionConfig): Connection;
-/**
- * Clear the singleton connection
- */
-declare function clearConnection(): Promise<void>;
-
-declare const ConnectionContext: React.Context<Connection | null>;
-interface ConnectionProviderProps {
-    config?: ConnectionConfig;
-    children: ReactNode;
-}
-declare function ConnectionProvider({ config, children }: ConnectionProviderProps): React.JSX.Element;
-
-declare function useConnection(overrideConfig?: ConnectionConfig): {
-    connect: () => Promise<void>;
-    disconnect: () => Promise<void>;
-    reconnect: () => Promise<void>;
-    client: WsClient | HttpClient | JsonHttpClient | JsonWsClient | null;
-    isConnected: boolean;
-    isConnecting: boolean;
-    connectionError: string | null;
-};
-
-interface QueryResult<T = any> {
-    columns: Column[];
-    rows: T[];
-    executionTimeMs: number;
-    rowsAffected?: number;
-}
-interface QueryState<T = any> {
-    isExecuting: boolean;
-    results: QueryResult<T>[] | undefined;
-    error: string | undefined;
-    executionTime: number | undefined;
-}
-interface QueryExecutorOptions {
-    connectionConfig?: ConnectionConfig;
-}
-declare function useQueryExecutor<T = any>(options?: QueryExecutorOptions): {
-    isExecuting: boolean;
-    results: QueryResult<T>[] | undefined;
-    error: string | undefined;
-    executionTime: number | undefined;
-    query: (rql: string, params?: any, shapes?: readonly ShapeNode[]) => Promise<void>;
-    cancelQuery: () => void;
-};
-
-interface QueryOptions extends QueryExecutorOptions {
-    connectionConfig?: ConnectionConfig;
-}
-declare function useQueryOne<S extends ShapeNode = any>(rql: string, params?: any, shape?: S, options?: QueryOptions): {
-    isExecuting: boolean;
-    result: QueryResult<S extends ShapeNode ? InferShape<S> : any> | undefined;
-    error: string | undefined;
-};
-declare function useQueryMany<S extends readonly ShapeNode[] = readonly ShapeNode[]>(rql: string, params?: any, shapes?: S, options?: QueryOptions): {
-    isExecuting: boolean;
-    results: QueryResult<S extends readonly ShapeNode[] ? InferShape<S[number]> : any>[] | undefined;
-    error: string | undefined;
-};
-
-interface CommandResult<T = any> {
-    columns: Column[];
-    rows: T[];
-    executionTimeMs: number;
-    rowsAffected?: number;
-}
-interface CommandState<T = any> {
-    isExecuting: boolean;
-    results: CommandResult<T>[] | undefined;
-    error: string | undefined;
-    executionTime: number | undefined;
-}
-interface CommandExecutorOptions {
-    connectionConfig?: ConnectionConfig;
-}
-declare function useCommandExecutor<T = any>(options?: CommandExecutorOptions): {
-    isExecuting: boolean;
-    results: CommandResult<T>[] | undefined;
-    error: string | undefined;
-    executionTime: number | undefined;
-    command: (rql: string, params?: any, shapes?: readonly ShapeNode[]) => Promise<void>;
-    cancelCommand: () => void;
-};
+declare function StoreProvider({ store, children }: StoreProviderProps): react_jsx_runtime.JSX.Element;
+declare function useStore(): Store;
 
-interface CommandOptions extends CommandExecutorOptions {
-    connectionConfig?: ConnectionConfig;
+interface UseSubscriptionOptions {
+    config?: SubscriptionConfig;
+    enabled?: boolean;
 }
-declare function useCommandOne<S extends ShapeNode = any>(rql: string, params?: any, shape?: S, options?: CommandOptions): {
-    isExecuting: boolean;
-    result: CommandResult<S extends ShapeNode ? InferShape<S> : any> | undefined;
-    error: string | undefined;
-};
-declare function useCommandMany<S extends readonly ShapeNode[] = readonly ShapeNode[]>(rql: string, params?: any, shapes?: S, options?: CommandOptions): {
-    isExecuting: boolean;
-    results: CommandResult<S extends readonly ShapeNode[] ? InferShape<S[number]> : any>[] | undefined;
-    error: string | undefined;
-};
+declare function useSubscription<S extends ShapeNode>(rql: string, params: any, shape: S, options?: UseSubscriptionOptions): Entry<InferShape<S>>;
 
-interface AdminResult<T = any> {
-    columns: Column[];
-    rows: T[];
-    executionTimeMs: number;
-    rowsAffected?: number;
-}
-interface AdminState<T = any> {
-    isExecuting: boolean;
-    results: AdminResult<T>[] | undefined;
-    error: string | undefined;
-    executionTime: number | undefined;
-}
-interface AdminExecutorOptions {
-    connectionConfig?: ConnectionConfig;
+interface UseQueryOptions {
+    enabled?: boolean;
 }
-declare function useAdminExecutor<T = any>(options?: AdminExecutorOptions): {
-    isExecuting: boolean;
-    results: AdminResult<T>[] | undefined;
-    error: string | undefined;
-    executionTime: number | undefined;
-    admin: (rql: string, params?: any, shapes?: readonly ShapeNode[]) => Promise<void>;
-    cancelAdmin: () => void;
-};
+declare function useQuery<S extends ShapeNode>(rql: string, params: any, shape: S, options?: UseQueryOptions): Entry<InferShape<S>>;
 
-interface AdminOptions extends AdminExecutorOptions {
-    connectionConfig?: ConnectionConfig;
+interface Runner<S extends readonly ShapeNode[]> {
+    run: (rql: string, params?: any) => Promise<FrameResults<S>>;
+    isPending: boolean;
+    error: Error | undefined;
 }
-declare function useAdminOne<S extends ShapeNode = any>(rql: string, params?: any, shape?: S, options?: AdminOptions): {
-    isExecuting: boolean;
-    result: AdminResult<S extends ShapeNode ? InferShape<S> : any> | undefined;
-    error: string | undefined;
-};
-declare function useAdminMany<S extends readonly ShapeNode[] = readonly ShapeNode[]>(rql: string, params?: any, shapes?: S, options?: AdminOptions): {
-    isExecuting: boolean;
-    results: AdminResult<S extends readonly ShapeNode[] ? InferShape<S[number]> : any>[] | undefined;
-    error: string | undefined;
-};
 
-interface SubscriptionExecutorOptions {
-    connectionConfig?: ConnectionConfig;
-}
-interface ChangeEvent<T> {
-    operation: 'INSERT' | 'UPDATE' | 'REMOVE';
-    rows: T[];
-    timestamp: number;
-}
-interface SubscriptionState<T> {
-    data: T[];
-    changes: ChangeEvent<T>[];
-    isSubscribed: boolean;
-    isSubscribing: boolean;
-    error: string | undefined;
-    subscriptionId: string | undefined;
-}
-declare function useSubscriptionExecutor<T = any>(options?: SubscriptionExecutorOptions): {
-    state: SubscriptionState<T>;
-    subscribe: (rql: string, params?: any, shape?: ShapeNode, config?: SubscriptionConfig) => Promise<void>;
-    unsubscribe: () => Promise<void>;
-    clearChanges: () => void;
-    clearData: () => void;
-};
+type UseCommandResult<S extends readonly ShapeNode[]> = Runner<S>;
+declare function useCommand<const S extends readonly ShapeNode[]>(shapes: S): UseCommandResult<S>;
 
-interface SubscriptionOptions extends SubscriptionExecutorOptions {
-    enabled?: boolean;
-    config?: SubscriptionConfig;
-}
-declare function useSubscription<S extends ShapeNode = any>(rql: string, params?: any, shape?: S, options?: SubscriptionOptions): {
-    data: InferShape<S>[];
-    changes: ChangeEvent<InferShape<S>>[];
-    isSubscribed: boolean;
-    isSubscribing: boolean;
-    error: string | undefined;
-    subscriptionId: string | undefined;
-};
-
-interface ColumnInfo {
-    name: string;
-    dataType: string;
-}
-interface TableInfo {
-    name: string;
-    columns: ColumnInfo[];
-}
-declare function useCatalog(): [boolean, TableInfo[], string | undefined];
+type UseAdminResult<S extends readonly ShapeNode[]> = Runner<S>;
+declare function useAdmin<const S extends readonly ShapeNode[]>(shapes: S): UseAdminResult<S>;
 
-export { type AdminExecutorOptions, type AdminOptions, type AdminResult, type AdminState, type ChangeEvent, type ColumnInfo, type CommandExecutorOptions, type CommandOptions, type CommandResult, type CommandState, Connection, type ConnectionConfig, ConnectionContext, ConnectionProvider, type ConnectionProviderProps, DEFAULT_CONFIG, DEFAULT_URL, type QueryExecutorOptions, type QueryOptions, type QueryResult, type QueryState, type SubscriptionExecutorOptions, type SubscriptionOptions, type SubscriptionState, type TableInfo, clearConnection, getConnection, useAdminExecutor, useAdminMany, useAdminOne, useCatalog, useCommandExecutor, useCommandMany, useCommandOne, useConnection, useQueryExecutor, useQueryMany, useQueryOne, useSubscription, useSubscriptionExecutor };
+export { StoreProvider, type StoreProviderProps, type UseAdminResult, type UseCommandResult, type UseQueryOptions, type UseSubscriptionOptions, useAdmin, useCommand, useQuery, useStore, useSubscription };