@tanstack/db 0.4.3 → 0.4.4

package/src/indexes/reverse-index.ts

@@ -0,0 +1,120 @@
+import type { CompareOptions } from "../query/builder/types"
+import type { OrderByDirection } from "../query/ir"
+import type { IndexInterface, IndexOperation, IndexStats } from "./base-index"
+import type { RangeQueryOptions } from "./btree-index"
+
+export class ReverseIndex<TKey extends string | number>
+  implements IndexInterface<TKey>
+{
+  private originalIndex: IndexInterface<TKey>
+
+  constructor(index: IndexInterface<TKey>) {
+    this.originalIndex = index
+  }
+
+  // Define the reversed operations
+
+  lookup(operation: IndexOperation, value: any): Set<TKey> {
+    const reverseOperation =
+      operation === `gt`
+        ? `lt`
+        : operation === `gte`
+          ? `lte`
+          : operation === `lt`
+            ? `gt`
+            : operation === `lte`
+              ? `gte`
+              : operation
+    return this.originalIndex.lookup(reverseOperation, value)
+  }
+
+  rangeQuery(options: RangeQueryOptions = {}): Set<TKey> {
+    return this.originalIndex.rangeQueryReversed(options)
+  }
+
+  rangeQueryReversed(options: RangeQueryOptions = {}): Set<TKey> {
+    return this.originalIndex.rangeQuery(options)
+  }
+
+  take(n: number, from?: any, filterFn?: (key: TKey) => boolean): Array<TKey> {
+    return this.originalIndex.takeReversed(n, from, filterFn)
+  }
+
+  takeReversed(
+    n: number,
+    from?: any,
+    filterFn?: (key: TKey) => boolean
+  ): Array<TKey> {
+    return this.originalIndex.take(n, from, filterFn)
+  }
+
+  get orderedEntriesArray(): Array<[any, Set<TKey>]> {
+    return this.originalIndex.orderedEntriesArrayReversed
+  }
+
+  get orderedEntriesArrayReversed(): Array<[any, Set<TKey>]> {
+    return this.originalIndex.orderedEntriesArray
+  }
+
+  // All operations below delegate to the original index
+
+  supports(operation: IndexOperation): boolean {
+    return this.originalIndex.supports(operation)
+  }
+
+  matchesField(fieldPath: Array<string>): boolean {
+    return this.originalIndex.matchesField(fieldPath)
+  }
+
+  matchesCompareOptions(compareOptions: CompareOptions): boolean {
+    return this.originalIndex.matchesCompareOptions(compareOptions)
+  }
+
+  matchesDirection(direction: OrderByDirection): boolean {
+    return this.originalIndex.matchesDirection(direction)
+  }
+
+  getStats(): IndexStats {
+    return this.originalIndex.getStats()
+  }
+
+  add(key: TKey, item: any): void {
+    this.originalIndex.add(key, item)
+  }
+
+  remove(key: TKey, item: any): void {
+    this.originalIndex.remove(key, item)
+  }
+
+  update(key: TKey, oldItem: any, newItem: any): void {
+    this.originalIndex.update(key, oldItem, newItem)
+  }
+
+  build(entries: Iterable<[TKey, any]>): void {
+    this.originalIndex.build(entries)
+  }
+
+  clear(): void {
+    this.originalIndex.clear()
+  }
+
+  get keyCount(): number {
+    return this.originalIndex.keyCount
+  }
+
+  equalityLookup(value: any): Set<TKey> {
+    return this.originalIndex.equalityLookup(value)
+  }
+
+  inArrayLookup(values: Array<any>): Set<TKey> {
+    return this.originalIndex.inArrayLookup(values)
+  }
+
+  get indexedKeysSet(): Set<TKey> {
+    return this.originalIndex.indexedKeysSet
+  }
+
+  get valueMapData(): Map<any, Set<TKey>> {
+    return this.originalIndex.valueMapData
+  }
+}

package/src/query/builder/index.ts

@@ -16,7 +16,7 @@ import {
   SubQueryMustHaveFromClauseError,
 } from "../../errors.js"
 import { createRefProxy, toExpression } from "./ref-proxy.js"
-import type { NamespacedRow } from "../../types.js"
+import type { NamespacedRow, SingleResult } from "../../types.js"
 import type {
   Aggregate,
   BasicExpression,
@@ -615,6 +615,28 @@ export class BaseQueryBuilder<TContext extends Context = Context> {
     }) as any
   }
 
+  /**
+   * Specify that the query should return a single result
+   * @returns A QueryBuilder that returns the first result
+   *
+   * @example
+   * ```ts
+   * // Get the user matching the query
+   * query
+   *   .from({ users: usersCollection })
+   *   .where(({users}) => eq(users.id, 1))
+   *   .findOne()
+   *```
+   */
+  findOne(): QueryBuilder<TContext & SingleResult> {
+    return new BaseQueryBuilder({
+      ...this.query,
+      // TODO: enforcing return only one result with also a default orderBy if none is specified
+      // limit: 1,
+      singleResult: true,
+    })
+  }
+
   // Helper methods
   private _getCurrentAliases(): Array<string> {
     const aliases: Array<string> = []
@@ -817,4 +839,10 @@ export type ExtractContext<T> =
       : never
 
 // Export the types from types.ts for convenience
-export type { Context, Source, GetResult, RefLeaf as Ref } from "./types.js"
+export type {
+  Context,
+  Source,
+  GetResult,
+  RefLeaf as Ref,
+  InferResultType,
+} from "./types.js"

package/src/query/builder/types.ts

@@ -1,4 +1,5 @@
 import type { CollectionImpl } from "../../collection/index.js"
+import type { SingleResult } from "../../types.js"
 import type {
   Aggregate,
   BasicExpression,
@@ -47,6 +48,8 @@ export interface Context {
   >
   // The result type after select (if select has been called)
   result?: any
+  // Single result only (if findOne has been called)
+  singleResult?: boolean
 }
 
 /**
@@ -571,6 +574,7 @@ export type MergeContextWithJoinType<
     [K in keyof TNewSchema & string]: TJoinType
   }
   result: TContext[`result`]
+  singleResult: TContext[`singleResult`] extends true ? true : false
 }
 
 /**
@@ -621,6 +625,14 @@ export type ApplyJoinOptionalityToMergedSchema<
       TNewSchema[K]
 }
 
+/**
+ * Utility type to infer the query result size (single row or an array)
+ */
+export type InferResultType<TContext extends Context> =
+  TContext extends SingleResult
+    ? GetResult<TContext> | undefined
+    : Array<GetResult<TContext>>
+
 /**
  * GetResult - Determines the final result type of a query
  *

package/src/query/compiler/group-by.ts

@@ -417,16 +417,7 @@ export function replaceAggregatesByRefs(
     }
 
     case `ref`: {
-      const refExpr = havingExpr
-      // Check if this is a direct reference to a SELECT alias
-      if (refExpr.path.length === 1) {
-        const alias = refExpr.path[0]!
-        if (selectClause[alias]) {
-          // This is a reference to a SELECT alias, convert to result.alias
-          return new PropRef([resultAlias, alias])
-        }
-      }
-      // Return as-is for other refs
+      // Non-aggregate refs are passed through unchanged (they reference table columns)
       return havingExpr as BasicExpression
     }
 

package/src/query/compiler/order-by.ts

@@ -9,7 +9,7 @@ import type { CompiledSingleRowExpression } from "./evaluators.js"
 import type { OrderByClause, QueryIR, Select } from "../ir.js"
 import type { NamespacedAndKeyedStream, NamespacedRow } from "../../types.js"
 import type { IStreamBuilder, KeyValue } from "@tanstack/db-ivm"
-import type { BaseIndex } from "../../indexes/base-index.js"
+import type { IndexInterface } from "../../indexes/base-index.js"
 import type { Collection } from "../../collection/index.js"
 
 export type OrderByOptimizationInfo = {
@@ -20,7 +20,7 @@ export type OrderByOptimizationInfo = {
     b: Record<string, unknown> | null | undefined
   ) => number
   valueExtractorForRawRow: (row: Record<string, unknown>) => any
-  index: BaseIndex<string | number>
+  index: IndexInterface<string | number>
   dataNeeded?: () => number
 }
 
@@ -54,18 +54,12 @@ export function processOrderBy(
 
   // Create a value extractor function for the orderBy operator
   const valueExtractor = (row: NamespacedRow & { __select_results?: any }) => {
-    // For ORDER BY expressions, we need to provide access to both:
-    // 1. The original namespaced row data (for direct table column references)
-    // 2. The __select_results (for SELECT alias references)
-
-    // Create a merged context for expression evaluation
-    const orderByContext = { ...row }
-
-    // If there are select results, merge them at the top level for alias access
-    if (row.__select_results) {
-      // Add select results as top-level properties for alias access
-      Object.assign(orderByContext, row.__select_results)
-    }
+    // The namespaced row contains:
+    // 1. Table aliases as top-level properties (e.g., row["tableName"])
+    // 2. SELECT results in __select_results (e.g., row.__select_results["aggregateAlias"])
+    // The replaceAggregatesByRefs function has already transformed any aggregate expressions
+    // that match SELECT aggregates to use the __select_results namespace.
+    const orderByContext = row
 
     if (orderByClause.length > 1) {
       // For multiple orderBy columns, create a composite key
@@ -132,6 +126,7 @@ export function processOrderBy(
           fieldName,
           followRefResult.path,
           followRefCollection,
+          clause.compareOptions,
           compare
         )
       }
@@ -150,10 +145,12 @@ export function processOrderBy(
         return compare(extractedA, extractedB)
       }
 
-      const index: BaseIndex<string | number> | undefined = findIndexForField(
-        followRefCollection.indexes,
-        followRefResult.path
-      )
+      const index: IndexInterface<string | number> | undefined =
+        findIndexForField(
+          followRefCollection.indexes,
+          followRefResult.path,
+          clause.compareOptions
+        )
 
       if (index && index.supports(`gt`)) {
         // We found an index that we can use to lazily load ordered data

package/src/query/index.ts

@@ -9,6 +9,7 @@ export {
   type Context,
   type Source,
   type GetResult,
+  type InferResultType,
 } from "./builder/index.js"
 
 // Expression functions exports

package/src/query/ir.ts

@@ -17,6 +17,7 @@ export interface QueryIR {
   limit?: Limit
   offset?: Offset
   distinct?: true
+  singleResult?: true
 
   // Functional variants
   fnSelect?: (row: NamespacedRow) => any

package/src/query/live/collection-config-builder.ts

@@ -7,7 +7,7 @@ import type { RootStreamBuilder } from "@tanstack/db-ivm"
 import type { OrderByOptimizationInfo } from "../compiler/order-by.js"
 import type { Collection } from "../../collection/index.js"
 import type {
-  CollectionConfig,
+  CollectionConfigSingleRowOption,
   KeyedStream,
   ResultStream,
   SyncConfig,
@@ -79,7 +79,7 @@ export class CollectionConfigBuilder<
     this.compileBasePipeline()
   }
 
-  getConfig(): CollectionConfig<TResult> {
+  getConfig(): CollectionConfigSingleRowOption<TResult> {
     return {
       id: this.id,
       getKey:
@@ -93,6 +93,7 @@ export class CollectionConfigBuilder<
       onUpdate: this.config.onUpdate,
       onDelete: this.config.onDelete,
       startSync: this.config.startSync,
+      singleResult: this.query.singleResult,
     }
   }
 

package/src/query/live/types.ts

@@ -90,4 +90,9 @@ export interface LiveQueryCollectionConfig<
    * GC time for the collection
    */
   gcTime?: number
+
+  /**
+   * If enabled the collection will return a single object instead of an array
+   */
+  singleResult?: true
 }

package/src/query/live-query-collection.ts

@@ -3,9 +3,29 @@ import { CollectionConfigBuilder } from "./live/collection-config-builder.js"
 import type { LiveQueryCollectionConfig } from "./live/types.js"
 import type { InitialQueryBuilder, QueryBuilder } from "./builder/index.js"
 import type { Collection } from "../collection/index.js"
-import type { CollectionConfig, UtilsRecord } from "../types.js"
+import type {
+  CollectionConfig,
+  CollectionConfigSingleRowOption,
+  NonSingleResult,
+  SingleResult,
+  UtilsRecord,
+} from "../types.js"
 import type { Context, GetResult } from "./builder/types.js"
 
+type CollectionConfigForContext<
+  TContext extends Context,
+  TResult extends object,
+> = TContext extends SingleResult
+  ? CollectionConfigSingleRowOption<TResult> & SingleResult
+  : CollectionConfigSingleRowOption<TResult> & NonSingleResult
+
+type CollectionForContext<
+  TContext extends Context,
+  TResult extends object,
+> = TContext extends SingleResult
+  ? Collection<TResult> & SingleResult
+  : Collection<TResult> & NonSingleResult
+
 /**
  * Creates live query collection options for use with createCollection
  *
@@ -35,12 +55,15 @@ export function liveQueryCollectionOptions<
   TResult extends object = GetResult<TContext>,
 >(
   config: LiveQueryCollectionConfig<TContext, TResult>
-): CollectionConfig<TResult> {
+): CollectionConfigForContext<TContext, TResult> {
   const collectionConfigBuilder = new CollectionConfigBuilder<
     TContext,
     TResult
   >(config)
-  return collectionConfigBuilder.getConfig()
+  return collectionConfigBuilder.getConfig() as CollectionConfigForContext<
+    TContext,
+    TResult
+  >
 }
 
 /**
@@ -83,7 +106,7 @@ export function createLiveQueryCollection<
   TResult extends object = GetResult<TContext>,
 >(
   query: (q: InitialQueryBuilder) => QueryBuilder<TContext>
-): Collection<TResult, string | number, {}>
+): CollectionForContext<TContext, TResult>
 
 // Overload 2: Accept full config object with optional utilities
 export function createLiveQueryCollection<
@@ -92,7 +115,7 @@ export function createLiveQueryCollection<
   TUtils extends UtilsRecord = {},
 >(
   config: LiveQueryCollectionConfig<TContext, TResult> & { utils?: TUtils }
-): Collection<TResult, string | number, TUtils>
+): CollectionForContext<TContext, TResult>
 
 // Implementation
 export function createLiveQueryCollection<
@@ -103,7 +126,7 @@ export function createLiveQueryCollection<
   configOrQuery:
     | (LiveQueryCollectionConfig<TContext, TResult> & { utils?: TUtils })
     | ((q: InitialQueryBuilder) => QueryBuilder<TContext>)
-): Collection<TResult, string | number, TUtils> {
+): CollectionForContext<TContext, TResult> {
   // Determine if the argument is a function (query) or a config object
   if (typeof configOrQuery === `function`) {
     // Simple query function case
@@ -113,7 +136,10 @@ export function createLiveQueryCollection<
       ) => QueryBuilder<TContext>,
     }
     const options = liveQueryCollectionOptions<TContext, TResult>(config)
-    return bridgeToCreateCollection(options)
+    return bridgeToCreateCollection(options) as CollectionForContext<
+      TContext,
+      TResult
+    >
   } else {
     // Config object case
     const config = configOrQuery as LiveQueryCollectionConfig<
@@ -124,7 +150,7 @@ export function createLiveQueryCollection<
     return bridgeToCreateCollection({
       ...options,
       utils: config.utils,
-    })
+    }) as CollectionForContext<TContext, TResult>
   }
 }
 

package/src/types.ts

@@ -503,6 +503,28 @@ export interface CollectionConfig<
   sync: SyncConfig<T, TKey>
 }
 
+export type SingleResult = {
+  singleResult: true
+}
+
+export type NonSingleResult = {
+  singleResult?: never
+}
+
+export type MaybeSingleResult = {
+  /**
+   * If enabled the collection will return a single object instead of an array
+   */
+  singleResult?: true
+}
+
+// Only used for live query collections
+export type CollectionConfigSingleRowOption<
+  T extends object = Record<string, unknown>,
+  TKey extends string | number = string | number,
+  TSchema extends StandardSchemaV1 = never,
+> = CollectionConfig<T, TKey, TSchema> & MaybeSingleResult
+
 export type ChangesPayload<T extends object = Record<string, unknown>> = Array<
   ChangeMessage<T>
 >

package/src/utils/index-optimization.ts

@@ -15,7 +15,14 @@
  * - Optimizes IN array expressions
  */
 
-import type { BaseIndex, IndexOperation } from "../indexes/base-index.js"
+import { DEFAULT_COMPARE_OPTIONS } from "../utils.js"
+import { ReverseIndex } from "../indexes/reverse-index.js"
+import type { CompareOptions } from "../query/builder/types.js"
+import type {
+  BaseIndex,
+  IndexInterface,
+  IndexOperation,
+} from "../indexes/base-index.js"
 import type { BasicExpression } from "../query/ir.js"
 
 /**
@@ -30,11 +37,18 @@ export interface OptimizationResult<TKey> {
  * Finds an index that matches a given field path
  */
 export function findIndexForField<TKey extends string | number>(
-  indexes: Map<number, BaseIndex<TKey>>,
-  fieldPath: Array<string>
-): BaseIndex<TKey> | undefined {
+  indexes: Map<number, IndexInterface<TKey>>,
+  fieldPath: Array<string>,
+  compareOptions: CompareOptions = DEFAULT_COMPARE_OPTIONS
+): IndexInterface<TKey> | undefined {
   for (const index of indexes.values()) {
-    if (index.matchesField(fieldPath)) {
+    if (
+      index.matchesField(fieldPath) &&
+      index.matchesCompareOptions(compareOptions)
+    ) {
+      if (!index.matchesDirection(compareOptions.direction)) {
+        return new ReverseIndex(index)
+      }
       return index
     }
   }

package/src/utils.ts

@@ -2,6 +2,8 @@
  * Generic utility functions
  */
 
+import type { CompareOptions } from "./query/builder/types"
+
 interface TypedArray {
   length: number
   [index: number]: number
@@ -209,3 +211,9 @@ export function isTemporal(a: any): boolean {
   const tag = getStringTag(a)
   return typeof tag === `string` && temporalTypes.includes(tag)
 }
+
+export const DEFAULT_COMPARE_OPTIONS: CompareOptions = {
+  direction: `asc`,
+  nulls: `first`,
+  stringSort: `locale`,
+}