@topgunbuild/client 0.9.0 → 0.10.0

package/dist/index.d.mts

@@ -99,7 +99,19 @@ interface QueryFilter {
     predicate?: PredicateNode;
     sort?: Record<string, 'asc' | 'desc'>;
     limit?: number;
-    offset?: number;
+    /** Cursor for pagination (Phase 14.1: replaces offset) */
+    cursor?: string;
+}
+/** Cursor status for debugging (Phase 14.1) */
+type CursorStatus = 'valid' | 'expired' | 'invalid' | 'none';
+/** Pagination info from server (Phase 14.1) */
+interface PaginationInfo {
+    /** Cursor for fetching next page */
+    nextCursor?: string;
+    /** Whether more results are available */
+    hasMore: boolean;
+    /** Debug info: status of input cursor processing */
+    cursorStatus: CursorStatus;
 }
 /** Source of query results for proper handling of race conditions */
 type QueryResultSource = 'local' | 'server';
@@ -117,6 +129,8 @@ declare class QueryHandle<T> {
     private changeTracker;
     private pendingChanges;
     private changeListeners;
+    private _paginationInfo;
+    private paginationListeners;
     constructor(syncEngine: SyncEngine, mapName: string, filter?: QueryFilter);
     subscribe(callback: (results: QueryResultItem<T>[]) => void): () => void;
     private loadInitialLocalData;
@@ -186,6 +200,26 @@ declare class QueryHandle<T> {
     private getSortedResults;
     getFilter(): QueryFilter;
     getMapName(): string;
+    /**
+     * Get current pagination info.
+     * Returns nextCursor, hasMore, and cursorStatus.
+     */
+    getPaginationInfo(): PaginationInfo;
+    /**
+     * Subscribe to pagination info changes.
+     * Called when server sends QUERY_RESP with new cursor info.
+     *
+     * @returns Unsubscribe function
+     */
+    onPaginationChange(listener: (info: PaginationInfo) => void): () => void;
+    /**
+     * Update pagination info from server response.
+     * Called by SyncEngine when processing QUERY_RESP.
+     *
+     * @internal
+     */
+    updatePaginationInfo(info: Partial<PaginationInfo>): void;
+    private notifyPaginationListeners;
 }
 
 /**
@@ -213,8 +247,8 @@ interface HybridQueryFilter {
     sort?: Record<string, 'asc' | 'desc'>;
     /** Maximum results */
     limit?: number;
-    /** Skip N results */
-    offset?: number;
+    /** Cursor for pagination (Phase 14.1: replaces offset) */
+    cursor?: string;
 }
 /**
  * Result item with score for hybrid queries.
@@ -265,6 +299,8 @@ declare class HybridQueryHandle<T> {
     private pendingChanges;
     private changeListeners;
     private hasReceivedServerData;
+    private _paginationInfo;
+    private paginationListeners;
     constructor(syncEngine: SyncEngine, mapName: string, filter?: HybridQueryFilter);
     /**
      * Subscribe to query results.
@@ -328,6 +364,26 @@ declare class HybridQueryHandle<T> {
      */
     hasFTSPredicate(): boolean;
     private containsFTS;
+    /**
+     * Get current pagination info.
+     * Returns nextCursor, hasMore, and cursorStatus.
+     */
+    getPaginationInfo(): PaginationInfo;
+    /**
+     * Subscribe to pagination info changes.
+     * Called when server sends HYBRID_QUERY_RESP with new cursor info.
+     *
+     * @returns Unsubscribe function
+     */
+    onPaginationChange(listener: (info: PaginationInfo) => void): () => void;
+    /**
+     * Update pagination info from server response.
+     * Called by SyncEngine when processing HYBRID_QUERY_RESP.
+     *
+     * @internal
+     */
+    updatePaginationInfo(info: Partial<PaginationInfo>): void;
+    private notifyPaginationListeners;
 }
 
 type TopicCallback = (data: any, context: {
@@ -1235,6 +1291,9 @@ declare class SyncEngine {
             score: number;
             matchedTerms: string[];
         }>;
+        nextCursor?: string;
+        hasMore?: boolean;
+        cursorStatus?: 'valid' | 'expired' | 'invalid' | 'none';
     }): void;
     /**
      * Handle hybrid query delta update from server.
@@ -1845,7 +1904,7 @@ declare class TopGunClient {
      * 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
+     * @param filter Hybrid query filter with predicate, where, sort, limit, cursor
      * @returns HybridQueryHandle for managing the subscription
      *
      * @example
@@ -2705,4 +2764,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 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 };
+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, type CursorStatus, 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, type PaginationInfo, 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

@@ -99,7 +99,19 @@ interface QueryFilter {
     predicate?: PredicateNode;
     sort?: Record<string, 'asc' | 'desc'>;
     limit?: number;
-    offset?: number;
+    /** Cursor for pagination (Phase 14.1: replaces offset) */
+    cursor?: string;
+}
+/** Cursor status for debugging (Phase 14.1) */
+type CursorStatus = 'valid' | 'expired' | 'invalid' | 'none';
+/** Pagination info from server (Phase 14.1) */
+interface PaginationInfo {
+    /** Cursor for fetching next page */
+    nextCursor?: string;
+    /** Whether more results are available */
+    hasMore: boolean;
+    /** Debug info: status of input cursor processing */
+    cursorStatus: CursorStatus;
 }
 /** Source of query results for proper handling of race conditions */
 type QueryResultSource = 'local' | 'server';
@@ -117,6 +129,8 @@ declare class QueryHandle<T> {
     private changeTracker;
     private pendingChanges;
     private changeListeners;
+    private _paginationInfo;
+    private paginationListeners;
     constructor(syncEngine: SyncEngine, mapName: string, filter?: QueryFilter);
     subscribe(callback: (results: QueryResultItem<T>[]) => void): () => void;
     private loadInitialLocalData;
@@ -186,6 +200,26 @@ declare class QueryHandle<T> {
     private getSortedResults;
     getFilter(): QueryFilter;
     getMapName(): string;
+    /**
+     * Get current pagination info.
+     * Returns nextCursor, hasMore, and cursorStatus.
+     */
+    getPaginationInfo(): PaginationInfo;
+    /**
+     * Subscribe to pagination info changes.
+     * Called when server sends QUERY_RESP with new cursor info.
+     *
+     * @returns Unsubscribe function
+     */
+    onPaginationChange(listener: (info: PaginationInfo) => void): () => void;
+    /**
+     * Update pagination info from server response.
+     * Called by SyncEngine when processing QUERY_RESP.
+     *
+     * @internal
+     */
+    updatePaginationInfo(info: Partial<PaginationInfo>): void;
+    private notifyPaginationListeners;
 }
 
 /**
@@ -213,8 +247,8 @@ interface HybridQueryFilter {
     sort?: Record<string, 'asc' | 'desc'>;
     /** Maximum results */
     limit?: number;
-    /** Skip N results */
-    offset?: number;
+    /** Cursor for pagination (Phase 14.1: replaces offset) */
+    cursor?: string;
 }
 /**
  * Result item with score for hybrid queries.
@@ -265,6 +299,8 @@ declare class HybridQueryHandle<T> {
     private pendingChanges;
     private changeListeners;
     private hasReceivedServerData;
+    private _paginationInfo;
+    private paginationListeners;
     constructor(syncEngine: SyncEngine, mapName: string, filter?: HybridQueryFilter);
     /**
      * Subscribe to query results.
@@ -328,6 +364,26 @@ declare class HybridQueryHandle<T> {
      */
     hasFTSPredicate(): boolean;
     private containsFTS;
+    /**
+     * Get current pagination info.
+     * Returns nextCursor, hasMore, and cursorStatus.
+     */
+    getPaginationInfo(): PaginationInfo;
+    /**
+     * Subscribe to pagination info changes.
+     * Called when server sends HYBRID_QUERY_RESP with new cursor info.
+     *
+     * @returns Unsubscribe function
+     */
+    onPaginationChange(listener: (info: PaginationInfo) => void): () => void;
+    /**
+     * Update pagination info from server response.
+     * Called by SyncEngine when processing HYBRID_QUERY_RESP.
+     *
+     * @internal
+     */
+    updatePaginationInfo(info: Partial<PaginationInfo>): void;
+    private notifyPaginationListeners;
 }
 
 type TopicCallback = (data: any, context: {
@@ -1235,6 +1291,9 @@ declare class SyncEngine {
             score: number;
             matchedTerms: string[];
         }>;
+        nextCursor?: string;
+        hasMore?: boolean;
+        cursorStatus?: 'valid' | 'expired' | 'invalid' | 'none';
     }): void;
     /**
      * Handle hybrid query delta update from server.
@@ -1845,7 +1904,7 @@ declare class TopGunClient {
      * 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
+     * @param filter Hybrid query filter with predicate, where, sort, limit, cursor
      * @returns HybridQueryHandle for managing the subscription
      *
      * @example
@@ -2705,4 +2764,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 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 };
+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, type CursorStatus, 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, type PaginationInfo, 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.js

@@ -1398,10 +1398,11 @@ var _SyncEngine = class _SyncEngine {
         break;
       }
       case "QUERY_RESP": {
-        const { queryId, results } = message.payload;
+        const { queryId, results, nextCursor, hasMore, cursorStatus } = message.payload;
         const query = this.queries.get(queryId);
         if (query) {
           query.onResult(results, "server");
+          query.updatePaginationInfo({ nextCursor, hasMore, cursorStatus });
         }
         break;
       }
@@ -2555,7 +2556,8 @@ var _SyncEngine = class _SyncEngine {
         where: filter.where,
         sort: filter.sort,
         limit: filter.limit,
-        offset: filter.offset
+        cursor: filter.cursor
+        // Phase 14.1: replaces offset
       }
     });
   }
@@ -2628,9 +2630,6 @@ var _SyncEngine = class _SyncEngine {
       });
     }
     let sliced = results;
-    if (filter.offset) {
-      sliced = sliced.slice(filter.offset);
-    }
     if (filter.limit) {
       sliced = sliced.slice(0, filter.limit);
     }
@@ -2643,6 +2642,11 @@ var _SyncEngine = class _SyncEngine {
     const query = this.hybridQueries.get(payload.subscriptionId);
     if (query) {
       query.onResult(payload.results, "server");
+      query.updatePaginationInfo({
+        nextCursor: payload.nextCursor,
+        hasMore: payload.hasMore,
+        cursorStatus: payload.cursorStatus
+      });
     }
   }
   /**
@@ -2765,6 +2769,9 @@ var QueryHandle = class {
     this.changeTracker = new ChangeTracker();
     this.pendingChanges = [];
     this.changeListeners = /* @__PURE__ */ new Set();
+    // Pagination info (Phase 14.1)
+    this._paginationInfo = { hasMore: false, cursorStatus: "none" };
+    this.paginationListeners = /* @__PURE__ */ new Set();
     // Track if we've received authoritative server response
     this.hasReceivedServerData = false;
     this.id = crypto.randomUUID();
@@ -2958,6 +2965,49 @@ var QueryHandle = class {
   getMapName() {
     return this.mapName;
   }
+  // ============== Pagination Methods (Phase 14.1) ==============
+  /**
+   * Get current pagination info.
+   * Returns nextCursor, hasMore, and cursorStatus.
+   */
+  getPaginationInfo() {
+    return { ...this._paginationInfo };
+  }
+  /**
+   * Subscribe to pagination info changes.
+   * Called when server sends QUERY_RESP with new cursor info.
+   *
+   * @returns Unsubscribe function
+   */
+  onPaginationChange(listener) {
+    this.paginationListeners.add(listener);
+    listener(this.getPaginationInfo());
+    return () => this.paginationListeners.delete(listener);
+  }
+  /**
+   * Update pagination info from server response.
+   * Called by SyncEngine when processing QUERY_RESP.
+   *
+   * @internal
+   */
+  updatePaginationInfo(info) {
+    this._paginationInfo = {
+      nextCursor: info.nextCursor,
+      hasMore: info.hasMore ?? false,
+      cursorStatus: info.cursorStatus ?? "none"
+    };
+    this.notifyPaginationListeners();
+  }
+  notifyPaginationListeners() {
+    const info = this.getPaginationInfo();
+    for (const listener of this.paginationListeners) {
+      try {
+        listener(info);
+      } catch (e) {
+        logger.error({ err: e }, "QueryHandle pagination listener error");
+      }
+    }
+  }
 };
 
 // src/DistributedLock.ts
@@ -3549,6 +3599,9 @@ var HybridQueryHandle = class {
     this.changeListeners = /* @__PURE__ */ new Set();
     // Track server data reception
     this.hasReceivedServerData = false;
+    // Pagination info (Phase 14.1)
+    this._paginationInfo = { hasMore: false, cursorStatus: "none" };
+    this.paginationListeners = /* @__PURE__ */ new Set();
     this.id = crypto.randomUUID();
     this.syncEngine = syncEngine;
     this.mapName = mapName;
@@ -3731,9 +3784,6 @@ var HybridQueryHandle = class {
       });
     }
     let sliced = results;
-    if (this.filter.offset) {
-      sliced = sliced.slice(this.filter.offset);
-    }
     if (this.filter.limit) {
       sliced = sliced.slice(0, this.filter.limit);
     }
@@ -3766,6 +3816,49 @@ var HybridQueryHandle = class {
     }
     return false;
   }
+  // ============== Pagination Methods (Phase 14.1) ==============
+  /**
+   * Get current pagination info.
+   * Returns nextCursor, hasMore, and cursorStatus.
+   */
+  getPaginationInfo() {
+    return { ...this._paginationInfo };
+  }
+  /**
+   * Subscribe to pagination info changes.
+   * Called when server sends HYBRID_QUERY_RESP with new cursor info.
+   *
+   * @returns Unsubscribe function
+   */
+  onPaginationChange(listener) {
+    this.paginationListeners.add(listener);
+    listener(this.getPaginationInfo());
+    return () => this.paginationListeners.delete(listener);
+  }
+  /**
+   * Update pagination info from server response.
+   * Called by SyncEngine when processing HYBRID_QUERY_RESP.
+   *
+   * @internal
+   */
+  updatePaginationInfo(info) {
+    this._paginationInfo = {
+      nextCursor: info.nextCursor,
+      hasMore: info.hasMore ?? false,
+      cursorStatus: info.cursorStatus ?? "none"
+    };
+    this.notifyPaginationListeners();
+  }
+  notifyPaginationListeners() {
+    const info = this.getPaginationInfo();
+    for (const listener of this.paginationListeners) {
+      try {
+        listener(info);
+      } catch (e) {
+        logger.error({ err: e }, "HybridQueryHandle pagination listener error");
+      }
+    }
+  }
 };
 
 // src/cluster/ClusterClient.ts
@@ -5661,7 +5754,7 @@ var TopGunClient = class {
    * 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
+   * @param filter Hybrid query filter with predicate, where, sort, limit, cursor
    * @returns HybridQueryHandle for managing the subscription
    *
    * @example