@topgunbuild/client 0.7.0 → 0.8.1

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { LWWRecord, ORMapRecord, PredicateNode, ConflictResolverDef, MergeRejection, Timestamp, LWWMap, ORMap, HLC, EntryProcessorDef, EntryProcessorResult, PNCounter, PNCounterState, JournalEvent, JournalEventType, NodeHealth, ConnectionPoolConfig, PartitionRouterConfig, PartitionMap, ClusterClientConfig } from '@topgunbuild/core';
+import { LWWRecord, ORMapRecord, PredicateNode, ConflictResolverDef, MergeRejection, Timestamp, LWWMap, ORMap, HLC, EntryProcessorDef, EntryProcessorResult, SearchOptions, PNCounter, PNCounterState, JournalEvent, JournalEventType, NodeHealth, ConnectionPoolConfig, PartitionRouterConfig, PartitionMap, ClusterClientConfig } from '@topgunbuild/core';
 export { LWWMap, LWWRecord, PredicateNode, Predicates } from '@topgunbuild/core';
 import pino from 'pino';
 
@@ -188,6 +188,148 @@ declare class QueryHandle<T> {
     getMapName(): string;
 }
 
+/**
+ * HybridQueryHandle - Query handle for hybrid FTS + filter queries
+ *
+ * Extends QueryHandle functionality to support:
+ * - FTS predicates (match, matchPhrase, matchPrefix)
+ * - Score-based sorting (_score field)
+ * - Hybrid queries combining FTS with traditional filters
+ *
+ * Part of Phase 12: Unified Search
+ *
+ * @module HybridQueryHandle
+ */
+
+/**
+ * Filter options for hybrid queries.
+ */
+interface HybridQueryFilter {
+    /** Traditional where clause filters */
+    where?: Record<string, any>;
+    /** Predicate tree (can include FTS predicates) */
+    predicate?: PredicateNode;
+    /** Sort configuration - use '_score' for FTS relevance sorting */
+    sort?: Record<string, 'asc' | 'desc'>;
+    /** Maximum results */
+    limit?: number;
+    /** Skip N results */
+    offset?: number;
+}
+/**
+ * Result item with score for hybrid queries.
+ */
+interface HybridResultItem<T> {
+    /** The document */
+    value: T;
+    /** Unique key */
+    _key: string;
+    /** Relevance score (only for FTS queries) */
+    _score?: number;
+    /** Matched terms (only for FTS queries) */
+    _matchedTerms?: string[];
+}
+/**
+ * Source of query results.
+ */
+type HybridResultSource = 'local' | 'server';
+/**
+ * HybridQueryHandle manages hybrid queries that combine FTS with filters.
+ *
+ * @example
+ * ```typescript
+ * // Create hybrid query: FTS + filter
+ * const handle = new HybridQueryHandle(syncEngine, 'articles', {
+ *   predicate: Predicates.and(
+ *     Predicates.match('body', 'machine learning'),
+ *     Predicates.equal('category', 'tech')
+ *   ),
+ *   sort: { _score: 'desc' },
+ *   limit: 20
+ * });
+ *
+ * // Subscribe to results
+ * handle.subscribe((results) => {
+ *   results.forEach(r => console.log(`${r._key}: ${r._score}`));
+ * });
+ * ```
+ */
+declare class HybridQueryHandle<T> {
+    readonly id: string;
+    private syncEngine;
+    private mapName;
+    private filter;
+    private listeners;
+    private currentResults;
+    private changeTracker;
+    private pendingChanges;
+    private changeListeners;
+    private hasReceivedServerData;
+    constructor(syncEngine: SyncEngine, mapName: string, filter?: HybridQueryFilter);
+    /**
+     * Subscribe to query results.
+     */
+    subscribe(callback: (results: HybridResultItem<T>[]) => void): () => void;
+    private loadInitialLocalData;
+    /**
+     * Called by SyncEngine with query results.
+     */
+    onResult(items: Array<{
+        key: string;
+        value: T;
+        score?: number;
+        matchedTerms?: string[];
+    }>, source?: HybridResultSource): void;
+    /**
+     * Called by SyncEngine on live update.
+     */
+    onUpdate(key: string, value: T | null, score?: number, matchedTerms?: string[]): void;
+    /**
+     * Subscribe to change events.
+     */
+    onChanges(listener: (changes: ChangeEvent<T>[]) => void): () => void;
+    /**
+     * Get and clear pending changes.
+     */
+    consumeChanges(): ChangeEvent<T>[];
+    /**
+     * Get last change without consuming.
+     */
+    getLastChange(): ChangeEvent<T> | null;
+    /**
+     * Get all pending changes without consuming.
+     */
+    getPendingChanges(): ChangeEvent<T>[];
+    /**
+     * Clear all pending changes.
+     */
+    clearChanges(): void;
+    /**
+     * Reset change tracker.
+     */
+    resetChangeTracker(): void;
+    private computeAndNotifyChanges;
+    private notifyChangeListeners;
+    private notify;
+    /**
+     * Get sorted results with _key and _score.
+     */
+    private getSortedResults;
+    /**
+     * Get the filter configuration.
+     */
+    getFilter(): HybridQueryFilter;
+    /**
+     * Get the map name.
+     */
+    getMapName(): string;
+    /**
+     * Check if this query contains FTS predicates.
+     */
+    hasFTSPredicate(): boolean;
+    private containsFTS;
+}
+
 type TopicCallback = (data: any, context: {
     timestamp: number;
     publisherId?: string;
@@ -639,6 +781,15 @@ declare class ConflictResolverClient {
     get rejectionListenerCount(): number;
 }
 
+/**
+ * Search result item from server.
+ */
+interface SearchResult<T> {
+    key: string;
+    value: T;
+    score: number;
+    matchedTerms: string[];
+}
 interface HeartbeatConfig {
     intervalMs: number;
     timeoutMs: number;
@@ -1026,11 +1177,76 @@ declare class SyncEngine {
      * Called internally when a message is received.
      */
     private emitMessage;
+    /** Pending search requests by requestId */
+    private pendingSearchRequests;
+    /** Default timeout for search requests (ms) */
+    private static readonly SEARCH_TIMEOUT;
+    /**
+     * Perform a one-shot BM25 search on the server.
+     *
+     * @param mapName Name of the map to search
+     * @param query Search query text
+     * @param options Search options (limit, minScore, boost)
+     * @returns Promise resolving to search results
+     */
+    search<T>(mapName: string, query: string, options?: SearchOptions): Promise<SearchResult<T>[]>;
+    /**
+     * Handle search response from server.
+     */
+    private handleSearchResponse;
     /**
      * Get the conflict resolver client for registering custom resolvers
      * and subscribing to merge rejection events.
      */
     getConflictResolverClient(): ConflictResolverClient;
+    /** Active hybrid query subscriptions */
+    private hybridQueries;
+    /**
+     * Subscribe to a hybrid query (FTS + filter combination).
+     */
+    subscribeToHybridQuery<T>(query: HybridQueryHandle<T>): void;
+    /**
+     * Unsubscribe from a hybrid query.
+     */
+    unsubscribeFromHybridQuery(queryId: string): void;
+    /**
+     * Send hybrid query subscription to server.
+     */
+    private sendHybridQuerySubscription;
+    /**
+     * Run a local hybrid query (FTS + filter combination).
+     * For FTS predicates, returns results with score = 0 (local-only mode).
+     * Server provides actual FTS scoring.
+     */
+    runLocalHybridQuery<T>(mapName: string, filter: HybridQueryFilter): Promise<Array<{
+        key: string;
+        value: T;
+        score?: number;
+        matchedTerms?: string[];
+    }>>;
+    /**
+     * Handle hybrid query response from server.
+     */
+    handleHybridQueryResponse(payload: {
+        subscriptionId: string;
+        results: Array<{
+            key: string;
+            value: unknown;
+            score: number;
+            matchedTerms: string[];
+        }>;
+    }): void;
+    /**
+     * Handle hybrid query delta update from server.
+     */
+    handleHybridQueryDelta(payload: {
+        subscriptionId: string;
+        key: string;
+        value: unknown | null;
+        score?: number;
+        matchedTerms?: string[];
+        type: 'ENTER' | 'UPDATE' | 'LEAVE';
+    }): void;
 }
 
 interface ILock {
@@ -1209,6 +1425,140 @@ declare class EventJournalReader {
     private generateRequestId;
 }
 
+/**
+ * SearchHandle - Client-side Live Search Subscription Handle
+ *
+ * Manages a live search subscription with delta updates.
+ * Part of Phase 11.1b: Live Search Subscriptions.
+ *
+ * @module SearchHandle
+ */
+
+/**
+ * Callback type for result change notifications.
+ */
+type SearchResultsCallback<T> = (results: SearchResult<T>[]) => void;
+/**
+ * SearchHandle manages a live search subscription.
+ *
+ * Provides:
+ * - Initial results on subscription
+ * - Real-time delta updates (ENTER/UPDATE/LEAVE)
+ * - Sorted results by relevance score
+ * - Query update without re-subscribing
+ *
+ * @example
+ * ```typescript
+ * const handle = client.searchSubscribe<Article>('articles', 'machine learning', {
+ *   limit: 20,
+ *   minScore: 0.5
+ * });
+ *
+ * // Subscribe to results
+ * const unsubscribe = handle.subscribe((results) => {
+ *   console.log('Results updated:', results.length);
+ * });
+ *
+ * // Get current snapshot
+ * const snapshot = handle.getResults();
+ *
+ * // Update query
+ * handle.setQuery('deep learning');
+ *
+ * // Cleanup
+ * handle.dispose();
+ * ```
+ */
+declare class SearchHandle<T = unknown> {
+    /** Map name being searched */
+    readonly mapName: string;
+    /** Current search query */
+    private _query;
+    /** Search options */
+    private _options?;
+    /** Unique subscription ID */
+    private subscriptionId;
+    /** Current results map (key → result) */
+    private results;
+    /** Result change listeners */
+    private listeners;
+    /** Whether the handle has been disposed */
+    private disposed;
+    /** Reference to SyncEngine */
+    private syncEngine;
+    /** Handler for all messages (SEARCH_RESP and SEARCH_UPDATE) */
+    private messageHandler;
+    constructor(syncEngine: SyncEngine, mapName: string, query: string, options?: SearchOptions);
+    /**
+     * Handle incoming messages (both SEARCH_RESP and SEARCH_UPDATE).
+     */
+    private handleMessage;
+    /**
+     * Get the current query string.
+     */
+    get query(): string;
+    /**
+     * Subscribe to result changes.
+     * Callback is immediately called with current results.
+     *
+     * @param callback - Function called with updated results
+     * @returns Unsubscribe function
+     */
+    subscribe(callback: SearchResultsCallback<T>): () => void;
+    /**
+     * Get current results snapshot sorted by score (highest first).
+     *
+     * @returns Array of search results
+     */
+    getResults(): SearchResult<T>[];
+    /**
+     * Get result count.
+     */
+    get size(): number;
+    /**
+     * Update the search query.
+     * Triggers a new subscription with the updated query.
+     *
+     * @param query - New query string
+     */
+    setQuery(query: string): void;
+    /**
+     * Update search options.
+     *
+     * @param options - New search options
+     */
+    setOptions(options: SearchOptions): void;
+    /**
+     * Dispose of the handle and cleanup resources.
+     * After disposal, the handle cannot be used.
+     */
+    dispose(): void;
+    /**
+     * Check if handle is disposed.
+     */
+    isDisposed(): boolean;
+    /**
+     * Send SEARCH_SUB message to server.
+     */
+    private sendSubscribe;
+    /**
+     * Send SEARCH_UNSUB message to server.
+     */
+    private sendUnsubscribe;
+    /**
+     * Handle SEARCH_RESP message (initial results).
+     */
+    private handleSearchResponse;
+    /**
+     * Handle SEARCH_UPDATE message (delta updates).
+     */
+    private handleSearchUpdate;
+    /**
+     * Notify all listeners of result changes.
+     */
+    private notifyListeners;
+}
+
 /**
  * Cluster mode configuration for TopGunClient.
  * When provided, the client connects to multiple nodes with partition-aware routing.
@@ -1418,6 +1768,107 @@ declare class TopGunClient {
      * ```
      */
     onBackpressure(event: 'backpressure:high' | 'backpressure:low' | 'backpressure:paused' | 'backpressure:resumed' | 'operation:dropped', listener: (data?: BackpressureThresholdEvent | OperationDroppedEvent) => void): () => void;
+    /**
+     * Perform a one-shot BM25 search on the server.
+     *
+     * Searches the specified map using BM25 ranking algorithm.
+     * Requires FTS to be enabled for the map on the server.
+     *
+     * @param mapName Name of the map to search
+     * @param query Search query text
+     * @param options Search options
+     * @returns Promise resolving to search results sorted by relevance
+     *
+     * @example
+     * ```typescript
+     * const results = await client.search<Article>('articles', 'machine learning', {
+     *   limit: 20,
+     *   minScore: 0.5,
+     *   boost: { title: 2.0, body: 1.0 }
+     * });
+     *
+     * for (const result of results) {
+     *   console.log(`${result.key}: ${result.value.title} (score: ${result.score})`);
+     * }
+     * ```
+     */
+    search<T>(mapName: string, query: string, options?: {
+        limit?: number;
+        minScore?: number;
+        boost?: Record<string, number>;
+    }): Promise<Array<{
+        key: string;
+        value: T;
+        score: number;
+        matchedTerms: string[];
+    }>>;
+    /**
+     * Subscribe to live search results with real-time updates.
+     *
+     * Unlike the one-shot `search()` method, `searchSubscribe()` returns a handle
+     * that receives delta updates (ENTER/UPDATE/LEAVE) when documents change.
+     * This is ideal for live search UIs that need to reflect data changes.
+     *
+     * @param mapName Name of the map to search
+     * @param query Search query text
+     * @param options Search options (limit, minScore, boost)
+     * @returns SearchHandle for managing the subscription
+     *
+     * @example
+     * ```typescript
+     * const handle = client.searchSubscribe<Article>('articles', 'machine learning', {
+     *   limit: 20,
+     *   minScore: 0.5
+     * });
+     *
+     * // Subscribe to result changes
+     * const unsubscribe = handle.subscribe((results) => {
+     *   setSearchResults(results);
+     * });
+     *
+     * // Update query dynamically
+     * handle.setQuery('deep learning');
+     *
+     * // Get current snapshot
+     * const snapshot = handle.getResults();
+     *
+     * // Cleanup when done
+     * handle.dispose();
+     * ```
+     */
+    searchSubscribe<T>(mapName: string, query: string, options?: SearchOptions): SearchHandle<T>;
+    /**
+     * Create a hybrid query combining FTS with traditional filters.
+     *
+     * Hybrid queries allow combining full-text search predicates (match, matchPhrase, matchPrefix)
+     * with traditional filter predicates (eq, gt, lt, contains, etc.) in a single query.
+     * Results include relevance scores for FTS ranking.
+     *
+     * @param mapName Name of the map to query
+     * @param filter Hybrid query filter with predicate, where, sort, limit, offset
+     * @returns HybridQueryHandle for managing the subscription
+     *
+     * @example
+     * ```typescript
+     * import { Predicates } from '@topgunbuild/core';
+     *
+     * // Hybrid query: FTS + filter
+     * const handle = client.hybridQuery<Article>('articles', {
+     *   predicate: Predicates.and(
+     *     Predicates.match('body', 'machine learning'),
+     *     Predicates.equal('category', 'tech')
+     *   ),
+     *   sort: { _score: 'desc' },
+     *   limit: 20
+     * });
+     *
+     * // Subscribe to results
+     * handle.subscribe((results) => {
+     *   results.forEach(r => console.log(`${r._key}: score=${r._score}`));
+     * });
+     * ```
+     */
+    hybridQuery<T>(mapName: string, filter?: HybridQueryFilter): HybridQueryHandle<T>;
     /**
      * Execute an entry processor on a single key atomically.
      *
@@ -2254,4 +2705,4 @@ declare class SingleServerProvider implements IConnectionProvider {
 
 declare const logger: pino.Logger<never, boolean>;
 
-export { type BackoffConfig, type BackpressureConfig, BackpressureError, type BackpressureStatus, type BackpressureStrategy, type BackpressureThresholdEvent, type ChangeEvent, ChangeTracker, type CircuitState, ClusterClient, type ClusterClientEvents, type ClusterRoutingMode, ConflictResolverClient, type ConnectionEventHandler, ConnectionPool, type ConnectionPoolEvents, type ConnectionProviderEvent, DEFAULT_BACKPRESSURE_CONFIG, DEFAULT_CLUSTER_CONFIG, EncryptedStorageAdapter, EventJournalReader, type HeartbeatConfig, type IConnectionProvider, IDBAdapter, type IStorageAdapter, type JournalEventData, type JournalSubscribeOptions, type OpLogEntry, type OperationDroppedEvent, PNCounterHandle, PartitionRouter, type PartitionRouterEvents, type QueryFilter, QueryHandle, type QueryResultItem, type QueryResultSource, type RegisterResult, type ResolverInfo, type RoutingMetrics, type RoutingResult, SingleServerProvider, type SingleServerProviderConfig, type StateChangeEvent, type StateChangeListener, SyncEngine, type SyncEngineConfig, SyncState, SyncStateMachine, type SyncStateMachineConfig, TopGun, TopGunClient, type TopGunClientConfig, type TopGunClusterConfig, type TopicCallback, TopicHandle, VALID_TRANSITIONS, isValidTransition, logger };
+export { type BackoffConfig, type BackpressureConfig, BackpressureError, type BackpressureStatus, type BackpressureStrategy, type BackpressureThresholdEvent, type ChangeEvent, ChangeTracker, type CircuitState, ClusterClient, type ClusterClientEvents, type ClusterRoutingMode, ConflictResolverClient, type ConnectionEventHandler, ConnectionPool, type ConnectionPoolEvents, type ConnectionProviderEvent, DEFAULT_BACKPRESSURE_CONFIG, DEFAULT_CLUSTER_CONFIG, EncryptedStorageAdapter, EventJournalReader, type HeartbeatConfig, type HybridQueryFilter, HybridQueryHandle, type HybridResultItem, type HybridResultSource, type IConnectionProvider, IDBAdapter, type IStorageAdapter, type JournalEventData, type JournalSubscribeOptions, type OpLogEntry, type OperationDroppedEvent, PNCounterHandle, PartitionRouter, type PartitionRouterEvents, type QueryFilter, QueryHandle, type QueryResultItem, type QueryResultSource, type RegisterResult, type ResolverInfo, type RoutingMetrics, type RoutingResult, SearchHandle, type SearchResult, type SearchResultsCallback, SingleServerProvider, type SingleServerProviderConfig, type StateChangeEvent, type StateChangeListener, SyncEngine, type SyncEngineConfig, SyncState, SyncStateMachine, type SyncStateMachineConfig, TopGun, TopGunClient, type TopGunClientConfig, type TopGunClusterConfig, type TopicCallback, TopicHandle, VALID_TRANSITIONS, isValidTransition, logger };