@tanstack/svelte-db 0.2.0 → 0.2.1

package/dist/useLiveInfiniteQuery.svelte.js

@@ -1,85 +1,72 @@
-import { createLiveQueryCollection, createLiveQueryWindowController, isCollection, } from '@tanstack/db';
-import { untrack } from 'svelte';
-const DEFAULT_PAGE_SIZE = 20;
+import { assertLiveQueryWindowManyResult, compareLiveQueryWindowDependencies, createLiveQueryCollection, createLiveQueryWindowController, fetchNextLiveQueryWindowPage, getLiveQueryWindowCollectionWarning, normalizeLiveQueryWindowPageSize, resolveLiveQueryWindowInput, shouldPreserveLiveQueryWindowPageCount, } from '@tanstack/db';
+import { tick, untrack } from 'svelte';
 const DEFAULT_GC_TIME_MS = 1;
-function hasSetWindow(collection) {
-    return typeof collection.utils.setWindow === `function`;
-}
-function normalizePageSize(pageSize) {
-    if (pageSize === undefined ||
-        !Number.isSafeInteger(pageSize) ||
-        pageSize <= 0) {
-        return DEFAULT_PAGE_SIZE;
-    }
-    return pageSize;
-}
-function resolveInput(input) {
-    if (isCollection(input)) {
-        return { kind: `collection`, collection: input };
-    }
-    if (typeof input !== `function`) {
-        throw new Error(`useLiveInfiniteQuery: First argument must be either a pre-created live query collection or a query function. ` +
-            `Received: ${typeof input}`);
-    }
-    // A zero-argument function can be a reactive collection getter. Query
-    // callbacks conventionally accept the builder, so avoid probing those.
-    if (input.length === 0) {
-        try {
-            const collection = input();
-            if (isCollection(collection)) {
-                return { kind: `collection`, collection };
-            }
-        }
-        catch {
-            // Query callbacks that close over their builder can still have arity 0.
-        }
-    }
-    return {
-        kind: `query`,
-        query: input,
-    };
-}
 export function useLiveInfiniteQuery(queryFnOrCollection, config, deps = []) {
     let validatedCollection = null;
-    const pageSize = $derived(normalizePageSize(config.pageSize));
+    let previousController = null;
+    let previousInput = null;
+    let previousDependencies = null;
+    let previousPageSize = null;
+    let previousInitialPageParam = null;
+    const pageSize = $derived(normalizeLiveQueryWindowPageSize(config.pageSize));
     const initialPageParam = $derived(config.initialPageParam ?? 0);
     const controller = $derived.by(() => {
-        for (const dependency of deps)
-            dependency();
-        const input = resolveInput(queryFnOrCollection);
+        const dependencies = deps.map((dependency) => dependency());
+        const input = resolveLiveQueryWindowInput(queryFnOrCollection);
+        const dependencyComparison = compareLiveQueryWindowDependencies(previousDependencies, dependencies);
+        const dependenciesChanged = dependencyComparison.changed;
+        const dependenciesStructurallyEqual = dependencyComparison.structurallyEqual;
+        const pageShapeChanged = previousPageSize !== pageSize ||
+            previousInitialPageParam !== initialPageParam;
+        const sameCollection = input.kind === `collection` &&
+            previousInput?.kind === `collection` &&
+            previousInput.collection === input.collection;
+        const canPreservePageCount = shouldPreserveLiveQueryWindowPageCount({
+            hasPreviousController: previousController !== null,
+            previousInputKind: previousInput?.kind,
+            inputKind: input.kind,
+            sameCollection,
+            dependenciesChanged,
+            dependenciesStructurallyEqual,
+            pageShapeChanged,
+        });
+        const previousPageCount = previousController
+            ? Math.max(1, previousController.getSnapshot().pages.length)
+            : 1;
+        const initialPageCount = canPreservePageCount ? previousPageCount : 1;
+        previousInput = input;
+        previousDependencies = [...dependencies];
+        previousPageSize = pageSize;
+        previousInitialPageParam = initialPageParam;
         if (input.kind === `collection`) {
             const collection = input.collection;
-            if (!hasSetWindow(collection)) {
-                throw new Error(`useLiveInfiniteQuery: Pre-created live query collection must have an orderBy clause for infinite pagination to work. ` +
-                    `Please add .orderBy() to your createLiveQueryCollection query.`);
-            }
+            const warning = getLiveQueryWindowCollectionWarning(collection, pageSize + 1);
             if (validatedCollection !== collection) {
                 validatedCollection = collection;
-                const currentWindow = collection.utils.getWindow?.();
-                const expectedLimit = pageSize + 1;
-                if (currentWindow &&
-                    (currentWindow.offset !== 0 || currentWindow.limit !== expectedLimit)) {
-                    console.warn(`useLiveInfiniteQuery: Pre-created collection has window {offset: ${currentWindow.offset}, limit: ${currentWindow.limit}} ` +
-                        `but the hook expects {offset: 0, limit: ${expectedLimit}}. Adjusting window now.`);
-                }
+                if (warning)
+                    console.warn(warning);
             }
-            return createLiveQueryWindowController(collection, {
+            const currentController = createLiveQueryWindowController(collection, {
                 pageSize,
                 initialPageParam,
+                initialPageCount,
             });
+            previousController = currentController;
+            return currentController;
         }
         const collection = createLiveQueryCollection({
-            query: (q) => input
-                .query(q)
-                .limit(pageSize + 1)
-                .offset(0),
+            query: input.query.limit(pageSize + 1).offset(0),
             startSync: false,
             gcTime: DEFAULT_GC_TIME_MS,
         });
-        return createLiveQueryWindowController(collection, {
+        assertLiveQueryWindowManyResult(collection);
+        const currentController = createLiveQueryWindowController(collection, {
             pageSize,
             initialPageParam,
+            initialPageCount,
         });
+        previousController = currentController;
+        return currentController;
     });
     let snapshot = $state.raw(untrack(() => controller.getSnapshot()));
     $effect(() => {
@@ -94,7 +81,13 @@ export function useLiveInfiniteQuery(queryFnOrCollection, config, deps = []) {
             currentController.dispose();
         };
     });
-    const fetchNextPage = () => controller.fetchNextPage();
+    const fetchNextPage = async () => {
+        // A dependency can invalidate the derived controller before Svelte runs the
+        // effect that subscribes it. Queue the imperative call until that handoff
+        // has completed so it cannot target an inactive controller.
+        await tick();
+        await fetchNextLiveQueryWindowPage(controller);
+    };
     return {
         get state() {
             return snapshot.state;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/svelte-db",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "Svelte integration for @tanstack/db",
   "author": "Kyle Mathews",
   "license": "MIT",
@@ -35,7 +35,7 @@
     "skills"
   ],
   "dependencies": {
-    "@tanstack/db": "0.7.0"
+    "@tanstack/db": "0.7.1"
   },
   "peerDependencies": {
     "svelte": "^5.0.0"