@marianmeres/fetch-store 3.1.0 → 3.1.1

package/README.md

@@ -99,10 +99,12 @@ const feed = createFetchStreamStore<Message>((emit, url: string) => {
     const es = new EventSource(url);
     es.onmessage = (e) => emit("data", JSON.parse(e.data));
     es.onerror = (e) => emit("error", e);
-    return () => { es.close(); emit("end"); };
+    return () => es.close();
 });
 
 const stop = feed.fetchStream(["/api/events"]);
+// ...later: closes the connection, sets isFetching: false
+stop();
 ```
 
 ## Features

package/dist/fetch-stream-store.d.ts

@@ -19,11 +19,11 @@ import type { FetchStreamEventName, FetchStreamStore, FetchStreamStoreOptions }
  *   const eventSource = new EventSource(url);
  *   eventSource.onmessage = (e) => emit("data", JSON.parse(e.data));
  *   eventSource.onerror = (e) => emit("error", e);
- *   return () => { eventSource.close(); emit("end"); };
+ *   return () => eventSource.close();
  * });
  *
  * const stop = sseStore.fetchStream(["/api/events"]);
- * // Later: stop() to close the connection
+ * // Later: stop() closes the connection and the run (isFetching: false, lastFetchEnd)
  * ```
  */
 export declare const createFetchStreamStore: <T, A extends unknown[] = unknown[]>(fetchStreamWorker: (emit: (eventName: FetchStreamEventName, eventData?: T | Error) => void, ...args: A) => (() => void) | void, initial?: T | null, options?: Partial<FetchStreamStoreOptions<T>>) => FetchStreamStore<T, A>;

package/dist/fetch-stream-store.js

@@ -19,11 +19,11 @@ const DEFAULT_OPTIONS = {};
  *   const eventSource = new EventSource(url);
  *   eventSource.onmessage = (e) => emit("data", JSON.parse(e.data));
  *   eventSource.onerror = (e) => emit("error", e);
- *   return () => { eventSource.close(); emit("end"); };
+ *   return () => eventSource.close();
  * });
  *
  * const stop = sseStore.fetchStream(["/api/events"]);
- * // Later: stop() to close the connection
+ * // Later: stop() closes the connection and the run (isFetching: false, lastFetchEnd)
  * ```
  */
 export const createFetchStreamStore = (fetchStreamWorker, initial = null, options = {}) => {
@@ -40,13 +40,17 @@ export const createFetchStreamStore = (fetchStreamWorker, initial = null, option
     const _dataStore = createStore(initial);
     const _metaStore = createStore(_createMetaObj());
     const { subscribe, get } = createDerivedStore([_dataStore, _metaStore], ([data, meta]) => ({ data, ...meta }));
-    // Tracks the cancel fn of the currently running stream so reset() can stop it.
-    let _currentCancel = null;
+    // Tracks the stop fn of the currently running stream so reset() and a new
+    // fetchStream() can stop it.
+    let _currentStop = null;
     const fetchStream = (fetchArgs = [], recursiveDelayMs = 0) => {
         let _timer;
         let _aborted = false;
         let _abortFn;
-        const cancel = () => {
+        // `closeRun` is false when the caller is about to overwrite meta anyway
+        // (reset, or a new fetchStream superseding this one), so subscribers see no
+        // intermediate `isFetching: false` flicker.
+        const stop = (closeRun) => {
             if (_aborted)
                 return;
             _aborted = true;
@@ -60,9 +64,18 @@ export const createFetchStreamStore = (fetchStreamWorker, initial = null, option
                     // cleanup should not throw, but guard anyway
                 }
             }
-            if (_currentCancel === cancel)
-                _currentCancel = null;
+            if (_currentStop === stop)
+                _currentStop = null;
+            // Every emit from here on is ignored (including an "end" from the cleanup
+            // above), so the store closes the run itself. Nothing to close when idle
+            // between recursive runs.
+            const meta = _metaStore.get();
+            if (closeRun && meta.isFetching) {
+                _metaStore.set({ ...meta, isFetching: false, lastFetchEnd: new Date() });
+            }
         };
+        // Public cancel fn takes no args (safe to pass directly as an event handler).
+        const cancel = () => stop(true);
         const normalizedArgs = (Array.isArray(fetchArgs) ? fetchArgs : [fetchArgs]);
         const runOnce = () => {
             if (_aborted)
@@ -131,19 +144,19 @@ export const createFetchStreamStore = (fetchStreamWorker, initial = null, option
                 });
             }
         };
-        // If a previous stream was still running, cancel it before starting a new one.
-        if (_currentCancel)
-            _currentCancel();
-        _currentCancel = cancel;
+        // If a previous stream was still running, stop it before starting a new one.
+        if (_currentStop)
+            _currentStop(false);
+        _currentStop = stop;
         runOnce();
         return cancel;
     };
     const reset = () => {
         // Stop any running stream (calls the worker's cleanup function).
-        if (_currentCancel) {
-            const c = _currentCancel;
-            _currentCancel = null;
-            c();
+        if (_currentStop) {
+            const s = _currentStop;
+            _currentStop = null;
+            s(false);
         }
         _dataStore.set(initial);
         _metaStore.set(_createMetaObj());

package/dist/types.d.ts

@@ -171,7 +171,8 @@ export interface FetchStreamStore<T, A extends unknown[] = unknown[]> extends St
      * Starts the stream and optionally restarts it after completion.
      * @param args - Arguments passed to the stream worker
      * @param recursiveDelayMs - Delay before restarting stream after "end" event (0 = no restart)
-     * @returns Cancel function to stop the stream
+     * @returns Cancel function: calls the worker's cleanup, ignores any later emits,
+     *   and closes the run (`isFetching: false`, `lastFetchEnd`) if it was still active.
      */
     fetchStream: (args?: A | unknown, recursiveDelayMs?: number | (() => number)) => () => void;
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@marianmeres/fetch-store",
-	"version": "3.1.0",
+	"version": "3.1.1",
 	"type": "module",
 	"main": "dist/mod.js",
 	"types": "dist/mod.d.ts",
@@ -14,7 +14,7 @@
 		"url": "https://github.com/marianmeres/fetch-store/issues"
 	},
 	"dependencies": {
-		"@marianmeres/pubsub": "^3.0.0",
-		"@marianmeres/store": "^3.0.0"
+		"@marianmeres/pubsub": "^3.1.0",
+		"@marianmeres/store": "^3.0.1"
 	}
 }