remove the sortBy config option, infer the sorting by presence of the _orderByIndex param

Author: samwillis

packages/optimistic/src/collection.ts

@@ -262,9 +262,19 @@ export class Collection<T extends object = Record<string, unknown>> {
     // Create a derived array from the map to avoid recalculating it
     this.derivedArray = new Derived({
       fn: ({ currDepVals: [stateMap] }) => {
-        const array = Array.from(stateMap.values())
-        if (config.sortBy) {
-          array.sort(config.sortBy)
+        // Collections returned by a query that has an orderBy are annotated
+        // with the _orderByIndex field.
+        // This is used to sort the array when it's derived.
+        const array: Array<T & { _orderByIndex?: number }> = Array.from(
+          stateMap.values()
+        )
+        if (array[0] && `_orderByIndex` in array[0]) {
+          ;(array as Array<T & { _orderByIndex: number }>).sort((a, b) => {
+            if (a._orderByIndex === b._orderByIndex) {
+              return 0
+            }
+            return a._orderByIndex < b._orderByIndex ? -1 : 1
+          })
         }
         return array
       },

packages/optimistic/src/query/compiled-query.ts

@@ -29,7 +29,6 @@ export class CompiledQuery<TResults extends object = Record<string, unknown>> {
   constructor(queryBuilder: QueryBuilder<Context<Schema>>) {
     const query = queryBuilder._query
     const collections = query.collections
-    const hasOrderBy = !!query.orderBy
 
     if (!collections) {
       throw new Error(`No collections provided`)
@@ -104,13 +103,6 @@ export class CompiledQuery<TResults extends object = Record<string, unknown>> {
       sync: {
         sync,
       },
-      sortBy: hasOrderBy
-        ? (a, b) => {
-            const aIndex = (a as { _orderByIndex: number })[`_orderByIndex`]
-            const bIndex = (b as { _orderByIndex: number })[`_orderByIndex`]
-            return aIndex - bIndex
-          }
-        : undefined,
     })
   }
 

packages/optimistic/src/types.ts

@@ -118,7 +118,6 @@ export interface CollectionConfig<T extends object = Record<string, unknown>> {
   id: string
   sync: SyncConfig<T>
   schema?: StandardSchema<T>
-  sortBy?: (a: T, b: T) => number
 }
 
 export type ChangesPayload<T extends object = Record<string, unknown>> = Array<