@topgunbuild/client 0.8.0 → 0.8.1

package/dist/index.d.mts

@@ -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;
@@ -1057,6 +1199,54 @@ declare class SyncEngine {
      * 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 {
@@ -1647,6 +1837,38 @@ declare class TopGunClient {
      * ```
      */
     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.
      *
@@ -2483,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, 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 };
+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 };

package/dist/index.d.ts

@@ -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;
@@ -1057,6 +1199,54 @@ declare class SyncEngine {
      * 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 {
@@ -1647,6 +1837,38 @@ declare class TopGunClient {
      * ```
      */
     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.
      *
@@ -2483,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, 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 };
+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 };