@reifydb/react 0.4.9 → 0.4.11

package/dist/index.d.ts

@@ -1,14 +1,14 @@
 import { Column, ShapeNode, InferShape } from '@reifydb/core';
 export * from '@reifydb/core';
-import { WsClientOptions, WsClient, HttpClient, JsonHttpClient, JsonWebsocketClient } from '@reifydb/client';
+import { WsClientOptions, WsClient, HttpClient, JsonHttpClient, JsonWsClient } from '@reifydb/client';
 export * from '@reifydb/client';
 import React, { ReactNode } from 'react';
 
 interface ConnectionState {
-    client: WsClient | HttpClient | JsonHttpClient | JsonWebsocketClient | null;
-    isConnected: boolean;
-    isConnecting: boolean;
-    connectionError: string | null;
+    client: WsClient | HttpClient | JsonHttpClient | JsonWsClient | null;
+    is_connected: boolean;
+    is_connecting: boolean;
+    connection_error: string | null;
     listeners: Set<(state: ConnectionState) => void>;
 }
 interface ConnectionConfig {
@@ -22,33 +22,33 @@ declare const DEFAULT_URL = "ws://127.0.0.1:8090";
 declare class Connection {
     private state;
     private config;
-    private connectPromise;
+    private connect_promise;
     constructor(config?: ConnectionConfig);
-    setConfig(config: ConnectionConfig): void;
-    getConfig(): ConnectionConfig;
+    set_config(config: ConnectionConfig): void;
+    get_config(): 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 | JsonWebsocketClient | null;
-    isConnected(): boolean;
-    isConnecting(): boolean;
-    getConnectionError(): string | null;
-    getState(): Omit<ConnectionState, 'listeners'>;
+    get_client(): WsClient | HttpClient | JsonHttpClient | JsonWsClient | null;
+    is_connected(): boolean;
+    is_connecting(): boolean;
+    get_connection_error(): string | null;
+    get_state(): Omit<ConnectionState, 'listeners'>;
     subscribe(listener: (state: ConnectionState) => void): () => void;
-    private updateState;
+    private update_state;
 }
 
 /**
  * Get the singleton connection instance.
- * If a config is provided, the connection's config will be updated via setConfig().
+ * If a config is provided, the connection's config will be updated via set_config().
  * @param config - Optional connection configuration
  * @returns The singleton Connection instance
  */
-declare function getConnection(config?: ConnectionConfig): Connection;
+declare function get_connection(config?: ConnectionConfig): Connection;
 /**
  * Clear the singleton connection
  */
-declare function clearConnection(): Promise<void>;
+declare function clear_connection(): Promise<void>;
 
 declare const ConnectionContext: React.Context<Connection | null>;
 interface ConnectionProviderProps {
@@ -57,50 +57,50 @@ interface ConnectionProviderProps {
 }
 declare function ConnectionProvider({ config, children }: ConnectionProviderProps): React.JSX.Element;
 
-declare function useConnection(overrideConfig?: ConnectionConfig): {
+declare function useConnection(override_config?: ConnectionConfig): {
     connect: () => Promise<void>;
     disconnect: () => Promise<void>;
     reconnect: () => Promise<void>;
-    client: WsClient | HttpClient | JsonHttpClient | JsonWebsocketClient | null;
-    isConnected: boolean;
-    isConnecting: boolean;
-    connectionError: string | null;
+    client: WsClient | HttpClient | JsonHttpClient | JsonWsClient | null;
+    is_connected: boolean;
+    is_connecting: boolean;
+    connection_error: string | null;
 };
 
 interface QueryResult<T = any> {
     columns: Column[];
     rows: T[];
-    executionTimeMs: number;
-    rowsAffected?: number;
+    execution_time_ms: number;
+    rows_affected?: number;
 }
 interface QueryState<T = any> {
-    isExecuting: boolean;
+    is_executing: boolean;
     results: QueryResult<T>[] | undefined;
     error: string | undefined;
-    executionTime: number | undefined;
+    execution_time: number | undefined;
 }
 interface QueryExecutorOptions {
-    connectionConfig?: ConnectionConfig;
+    connection_config?: ConnectionConfig;
 }
 declare function useQueryExecutor<T = any>(options?: QueryExecutorOptions): {
-    isExecuting: boolean;
+    is_executing: boolean;
     results: QueryResult<T>[] | undefined;
     error: string | undefined;
-    executionTime: number | undefined;
-    query: (statements: string | string[], params?: any, shapes?: readonly ShapeNode[]) => Promise<void>;
-    cancelQuery: () => void;
+    execution_time: number | undefined;
+    query: (rql: string, params?: any, shapes?: readonly ShapeNode[]) => Promise<void>;
+    cancel_query: () => void;
 };
 
 interface QueryOptions extends QueryExecutorOptions {
-    connectionConfig?: ConnectionConfig;
+    connection_config?: ConnectionConfig;
 }
 declare function useQueryOne<S extends ShapeNode = any>(rql: string, params?: any, shape?: S, options?: QueryOptions): {
-    isExecuting: boolean;
+    is_executing: boolean;
     result: QueryResult<S extends ShapeNode ? InferShape<S> : any> | undefined;
     error: string | undefined;
 };
-declare function useQueryMany<S extends readonly ShapeNode[] = readonly ShapeNode[]>(statements: string | string[], params?: any, shapes?: S, options?: QueryOptions): {
-    isExecuting: boolean;
+declare function useQueryMany<S extends readonly ShapeNode[] = readonly ShapeNode[]>(rql: string, params?: any, shapes?: S, options?: QueryOptions): {
+    is_executing: boolean;
     results: QueryResult<S extends readonly ShapeNode[] ? InferShape<S[number]> : any>[] | undefined;
     error: string | undefined;
 };
@@ -108,37 +108,37 @@ declare function useQueryMany<S extends readonly ShapeNode[] = readonly ShapeNod
 interface CommandResult<T = any> {
     columns: Column[];
     rows: T[];
-    executionTimeMs: number;
-    rowsAffected?: number;
+    execution_time_ms: number;
+    rows_affected?: number;
 }
 interface CommandState<T = any> {
-    isExecuting: boolean;
+    is_executing: boolean;
     results: CommandResult<T>[] | undefined;
     error: string | undefined;
-    executionTime: number | undefined;
+    execution_time: number | undefined;
 }
 interface CommandExecutorOptions {
-    connectionConfig?: ConnectionConfig;
+    connection_config?: ConnectionConfig;
 }
 declare function useCommandExecutor<T = any>(options?: CommandExecutorOptions): {
-    isExecuting: boolean;
+    is_executing: boolean;
     results: CommandResult<T>[] | undefined;
     error: string | undefined;
-    executionTime: number | undefined;
-    command: (statements: string | string[], params?: any, shapes?: readonly ShapeNode[]) => Promise<void>;
-    cancelCommand: () => void;
+    execution_time: number | undefined;
+    command: (rql: string, params?: any, shapes?: readonly ShapeNode[]) => Promise<void>;
+    cancel_command: () => void;
 };
 
 interface CommandOptions extends CommandExecutorOptions {
-    connectionConfig?: ConnectionConfig;
+    connection_config?: ConnectionConfig;
 }
-declare function useCommandOne<S extends ShapeNode = any>(statement: string, params?: any, shape?: S, options?: CommandOptions): {
-    isExecuting: boolean;
+declare function useCommandOne<S extends ShapeNode = any>(rql: string, params?: any, shape?: S, options?: CommandOptions): {
+    is_executing: boolean;
     result: CommandResult<S extends ShapeNode ? InferShape<S> : any> | undefined;
     error: string | undefined;
 };
-declare function useCommandMany<S extends readonly ShapeNode[] = readonly ShapeNode[]>(statements: string | string[], params?: any, shapes?: S, options?: CommandOptions): {
-    isExecuting: boolean;
+declare function useCommandMany<S extends readonly ShapeNode[] = readonly ShapeNode[]>(rql: string, params?: any, shapes?: S, options?: CommandOptions): {
+    is_executing: boolean;
     results: CommandResult<S extends readonly ShapeNode[] ? InferShape<S[number]> : any>[] | undefined;
     error: string | undefined;
 };
@@ -146,43 +146,43 @@ declare function useCommandMany<S extends readonly ShapeNode[] = readonly ShapeN
 interface AdminResult<T = any> {
     columns: Column[];
     rows: T[];
-    executionTimeMs: number;
-    rowsAffected?: number;
+    execution_time_ms: number;
+    rows_affected?: number;
 }
 interface AdminState<T = any> {
-    isExecuting: boolean;
+    is_executing: boolean;
     results: AdminResult<T>[] | undefined;
     error: string | undefined;
-    executionTime: number | undefined;
+    execution_time: number | undefined;
 }
 interface AdminExecutorOptions {
-    connectionConfig?: ConnectionConfig;
+    connection_config?: ConnectionConfig;
 }
 declare function useAdminExecutor<T = any>(options?: AdminExecutorOptions): {
-    isExecuting: boolean;
+    is_executing: boolean;
     results: AdminResult<T>[] | undefined;
     error: string | undefined;
-    executionTime: number | undefined;
-    admin: (statements: string | string[], params?: any, shapes?: readonly ShapeNode[]) => Promise<void>;
-    cancelAdmin: () => void;
+    execution_time: number | undefined;
+    admin: (rql: string, params?: any, shapes?: readonly ShapeNode[]) => Promise<void>;
+    cancel_admin: () => void;
 };
 
 interface AdminOptions extends AdminExecutorOptions {
-    connectionConfig?: ConnectionConfig;
+    connection_config?: ConnectionConfig;
 }
-declare function useAdminOne<S extends ShapeNode = any>(statement: string, params?: any, shape?: S, options?: AdminOptions): {
-    isExecuting: boolean;
+declare function useAdminOne<S extends ShapeNode = any>(rql: string, params?: any, shape?: S, options?: AdminOptions): {
+    is_executing: boolean;
     result: AdminResult<S extends ShapeNode ? InferShape<S> : any> | undefined;
     error: string | undefined;
 };
-declare function useAdminMany<S extends readonly ShapeNode[] = readonly ShapeNode[]>(statements: string | string[], params?: any, shapes?: S, options?: AdminOptions): {
-    isExecuting: boolean;
+declare function useAdminMany<S extends readonly ShapeNode[] = readonly ShapeNode[]>(rql: string, params?: any, shapes?: S, options?: AdminOptions): {
+    is_executing: boolean;
     results: AdminResult<S extends readonly ShapeNode[] ? InferShape<S[number]> : any>[] | undefined;
     error: string | undefined;
 };
 
 interface SubscriptionExecutorOptions {
-    connectionConfig?: ConnectionConfig;
+    connection_config?: ConnectionConfig;
 }
 interface ChangeEvent<T> {
     operation: 'INSERT' | 'UPDATE' | 'REMOVE';
@@ -192,34 +192,34 @@ interface ChangeEvent<T> {
 interface SubscriptionState<T> {
     data: T[];
     changes: ChangeEvent<T>[];
-    isSubscribed: boolean;
-    isSubscribing: boolean;
+    is_subscribed: boolean;
+    is_subscribing: boolean;
     error: string | undefined;
-    subscriptionId: string | undefined;
+    subscription_id: string | undefined;
 }
 declare function useSubscriptionExecutor<T = any>(options?: SubscriptionExecutorOptions): {
     state: SubscriptionState<T>;
-    subscribe: (query: string, params?: any, shape?: ShapeNode) => Promise<void>;
+    subscribe: (rql: string, params?: any, shape?: ShapeNode) => Promise<void>;
     unsubscribe: () => Promise<void>;
-    clearChanges: () => void;
-    clearData: () => void;
+    clear_changes: () => void;
+    clear_data: () => void;
 };
 
 interface SubscriptionOptions extends SubscriptionExecutorOptions {
     enabled?: boolean;
 }
-declare function useSubscription<S extends ShapeNode = any>(query: string, params?: any, shape?: S, options?: SubscriptionOptions): {
+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;
+    is_subscribed: boolean;
+    is_subscribing: boolean;
     error: string | undefined;
-    subscriptionId: string | undefined;
+    subscription_id: string | undefined;
 };
 
 interface ColumnInfo {
     name: string;
-    dataType: string;
+    data_type: string;
 }
 interface TableInfo {
     name: string;
@@ -227,4 +227,4 @@ interface TableInfo {
 }
 declare function useShape(): [boolean, TableInfo[], string | undefined];
 
-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, useCommandExecutor, useCommandMany, useCommandOne, useConnection, useQueryExecutor, useQueryMany, useQueryOne, useShape, useSubscription, useSubscriptionExecutor };
+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, clear_connection, get_connection, useAdminExecutor, useAdminMany, useAdminOne, useCommandExecutor, useCommandMany, useCommandOne, useConnection, useQueryExecutor, useQueryMany, useQueryOne, useShape, useSubscription, useSubscriptionExecutor };