synstate 0.1.2 → 1.0.1

package/src/core/operators/merge-map.mts

@@ -5,7 +5,7 @@ import {
   type MergeMapOperatorObservable,
   type Observable,
   type Subscription,
-  type UpdaterSymbol,
+  type UpdateToken,
 } from '../types/index.mjs';
 
 /**
@@ -21,56 +21,83 @@ import {
  * ```ts
  * //  Timeline:
  * //
- * //  ids$          1               2               3
- * //  requests      fetch(1)        fetch(2)        fetch(3)
- * //  users$        result1         result2         result3
- * //                (parallel)      (parallel)      (parallel)
+ * //  input$      A                          B              C
+ * //  inner A     A1    A2    A3
+ * //  inner B                                B1    B2             B3
+ * //  inner C                                              C1         C2    C3
+ * //  result$     A1    A2    A3              B1    B2      C1    B3   C2    C3
  * //
  * //  Explanation:
- * //  - mergeMap runs all inner observables in parallel
- * //  - Results are emitted as they arrive (may be out of order)
- * //  - Does NOT cancel previous requests
- * //  - All requests run concurrently and all results are emitted
+ * //  - mergeMap creates an inner observable for each source value
+ * //  - Unlike switchMap, previous inner observables are NOT cancelled
+ * //  - B's inner continues even after C arrives (B3 is still emitted)
+ * //  - All inner observables run concurrently and their results are merged
  *
- * const ids$ = source<number>();
+ * const input$ = source<string>();
  *
- * const users$ = ids$.pipe(
- *   mergeMap((id) => {
- *     const result$ = source<{ id: number }>();
+ * const result$ = input$.pipe(
+ *   mergeMap((letter) => {
+ *     const inner$ = source<string>();
  *
  *     setTimeout(() => {
- *       result$.next({ id });
- *
- *       result$.complete();
+ *       inner$.next(`${letter}1`);
  *     }, 10);
  *
- *     return result$;
+ *     setTimeout(() => {
+ *       inner$.next(`${letter}2`);
+ *     }, 110);
+ *
+ *     setTimeout(() => {
+ *       inner$.next(`${letter}3`);
+ *     }, 210);
+ *
+ *     return inner$;
  *   }),
  * );
  *
- * const mut_history: { id: number }[] = [];
+ * const valueHistory: string[] = [];
  *
- * users$.subscribe((value) => {
- *   mut_history.push(value);
+ * result$.subscribe((value) => {
+ *   valueHistory.push(value);
  * });
  *
- * ids$.next(1);
+ * const sleep = (ms: number): Promise<void> =>
+ *   new Promise((resolve) => {
+ *     setTimeout(resolve, ms);
+ *   });
  *
- * ids$.next(2);
+ * // Emit A - inner emits A1, A2, A3 at 10ms, 110ms, 210ms
+ * input$.next('A');
  *
- * ids$.next(3);
+ * await sleep(250);
  *
- * await new Promise((resolve) => {
- *   setTimeout(resolve, 200);
- * });
+ * assert.deepStrictEqual(valueHistory, ['A1', 'A2', 'A3']);
+ *
+ * // Emit B - inner starts emitting B1, B2 at 10ms, 110ms
+ * input$.next('B');
+ *
+ * await sleep(150);
  *
- * assert.deepStrictEqual(mut_history.length, 3);
+ * assert.deepStrictEqual(valueHistory, ['A1', 'A2', 'A3', 'B1', 'B2']);
  *
- * assert.isTrue(mut_history.some((u) => u.id === 1));
+ * // Emit C while B's inner is still running (B3 at 210ms not yet fired)
+ * // Unlike switchMap, B's inner is NOT cancelled
+ * input$.next('C');
  *
- * assert.isTrue(mut_history.some((u) => u.id === 2));
+ * await sleep(250);
  *
- * assert.isTrue(mut_history.some((u) => u.id === 3));
+ * // B3 appears between C1 and C2, showing the merge behavior
+ * assert.deepStrictEqual(valueHistory, [
+ *   'A1',
+ *   'A2',
+ *   'A3',
+ *   'B1',
+ *   'B2',
+ *   'C1',
+ *   'B3',
+ *   'C2',
+ *   'C3',
+ * ]);
  * ```
  *
  * @note To improve code readability, consider using `createState` instead of `mergeMap`,
@@ -113,12 +140,12 @@ class MergeMapObservableClass<A, B>
     this.#mut_subscriptions = [];
   }
 
-  override tryUpdate(updaterSymbol: UpdaterSymbol): void {
+  override tryUpdate(updateToken: UpdateToken): void {
     const par = this.parents[0];
 
     const sn = par.getSnapshot();
 
-    if (par.updaterSymbol !== updaterSymbol || Optional.isNone(sn)) {
+    if (par.updateToken !== updateToken || Optional.isNone(sn)) {
       return; // skip update
     }
 

package/src/core/operators/pairwise.mts

@@ -4,7 +4,7 @@ import {
   type DropInitialValueOperator,
   type Observable,
   type PairwiseOperatorObservable,
-  type UpdaterSymbol,
+  type UpdateToken,
 } from '../types/index.mjs';
 
 /**
@@ -30,30 +30,30 @@ import {
  *
  * const pairs$ = num$.pipe(pairwise());
  *
- * const mut_history: (readonly [number, number])[] = [];
+ * const valueHistory: (readonly [number, number])[] = [];
  *
  * pairs$.subscribe(([prev, curr]) => {
- *   mut_history.push([prev, curr]);
+ *   valueHistory.push([prev, curr]);
  * });
  *
  * num$.next(1); // nothing logged
  *
- * assert.deepStrictEqual(mut_history, []);
+ * assert.deepStrictEqual(valueHistory, []);
  *
  * num$.next(2); // logs: 1, 2
  *
- * assert.deepStrictEqual(mut_history, [[1, 2]]);
+ * assert.deepStrictEqual(valueHistory, [[1, 2]]);
  *
  * num$.next(3); // logs: 2, 3
  *
- * assert.deepStrictEqual(mut_history, [
+ * assert.deepStrictEqual(valueHistory, [
  *   [1, 2],
  *   [2, 3],
  * ]);
  *
  * num$.next(4); // logs: 3, 4
  *
- * assert.deepStrictEqual(mut_history, [
+ * assert.deepStrictEqual(valueHistory, [
  *   [1, 2],
  *   [2, 3],
  *   [3, 4],
@@ -83,12 +83,12 @@ class PairwiseObservableClass<A>
     this.#mut_previousValue = parentObservable.getSnapshot();
   }
 
-  override tryUpdate(updaterSymbol: UpdaterSymbol): void {
+  override tryUpdate(updateToken: UpdateToken): void {
     const par = this.parents[0];
 
     const sn = par.getSnapshot();
 
-    if (par.updaterSymbol !== updaterSymbol || Optional.isNone(sn)) {
+    if (par.updateToken !== updateToken || Optional.isNone(sn)) {
       return; // skip update
     }
 
@@ -100,7 +100,7 @@ class PairwiseObservableClass<A>
     this.#mut_previousValue = par.getSnapshot();
 
     if (cond) {
-      this.setNext([prev.value, sn.value], updaterSymbol);
+      this.setNext([prev.value, sn.value], updateToken);
     }
   }
 }

package/src/core/operators/scan.mts

@@ -3,7 +3,7 @@ import { InitializedSyncChildObservableClass } from '../class/index.mjs';
 import {
   type Observable,
   type ScanOperatorObservable,
-  type UpdaterSymbol,
+  type UpdateToken,
   type WithInitialValueOperator,
 } from '../types/index.mjs';
 
@@ -35,25 +35,25 @@ import {
  *
  * const sum$ = num$.pipe(scan((acc, curr) => acc + curr, 0));
  *
- * const mut_history: number[] = [];
+ * const valueHistory: number[] = [];
  *
  * sum$.subscribe((x) => {
- *   mut_history.push(x);
+ *   valueHistory.push(x);
  * });
  *
- * assert.deepStrictEqual(mut_history, [0]);
+ * assert.deepStrictEqual(valueHistory, [0]);
  *
  * num$.next(1); // logs: 1
  *
- * assert.deepStrictEqual(mut_history, [0, 1]);
+ * assert.deepStrictEqual(valueHistory, [0, 1]);
  *
  * num$.next(2); // logs: 3
  *
- * assert.deepStrictEqual(mut_history, [0, 1, 3]);
+ * assert.deepStrictEqual(valueHistory, [0, 1, 3]);
  *
  * num$.next(3); // logs: 6
  *
- * assert.deepStrictEqual(mut_history, [0, 1, 3, 6]);
+ * assert.deepStrictEqual(valueHistory, [0, 1, 3, 6]);
  * ```
  */
 export const scan =
@@ -83,7 +83,7 @@ class ScanObservableClass<A, B>
     this.#reducer = reducer;
   }
 
-  override tryUpdate(updaterSymbol: UpdaterSymbol): void {
+  override tryUpdate(updateToken: UpdateToken): void {
     const par = this.parents[0];
 
     const psn = par.getSnapshot();
@@ -91,13 +91,13 @@ class ScanObservableClass<A, B>
     const sn = this.getSnapshot();
 
     if (
-      par.updaterSymbol !== updaterSymbol ||
+      par.updateToken !== updateToken ||
       Optional.isNone(psn) ||
       Optional.isNone(sn)
     ) {
       return; // skip update
     }
 
-    this.setNext(this.#reducer(sn.value, psn.value), updaterSymbol);
+    this.setNext(this.#reducer(sn.value, psn.value), updateToken);
   }
 }

package/src/core/operators/skip-if-no-change.mts

@@ -4,7 +4,7 @@ import {
   type KeepInitialValueOperator,
   type Observable,
   type SkipIfNoChangeOperatorObservable,
-  type UpdaterSymbol,
+  type UpdateToken,
 } from '../types/index.mjs';
 
 /**
@@ -19,8 +19,8 @@ import {
  * ```ts
  * //  Timeline:
  * //
- * //  num$      1     1     2     2     2     3
- * //  distinct$ 1           2                 3
+ * //  num$      1     1     2     2     1     2     3     2
+ * //  distinct$ 1           2           1     2     3     2
  * //
  * //  Explanation:
  * //  - skipIfNoChange filters out consecutive duplicate values
@@ -31,29 +31,41 @@ import {
  *
  * const distinct$ = num$.pipe(skipIfNoChange());
  *
- * const mut_history: number[] = [];
+ * const valueHistory: number[] = [];
  *
  * distinct$.subscribe((x) => {
- *   mut_history.push(x);
+ *   valueHistory.push(x);
  * });
  *
  * num$.next(1); // logs: 1
  *
- * assert.deepStrictEqual(mut_history, [1]);
+ * assert.deepStrictEqual(valueHistory, [1]);
  *
  * num$.next(1); // nothing logged
  *
- * assert.deepStrictEqual(mut_history, [1]);
+ * assert.deepStrictEqual(valueHistory, [1]);
  *
  * num$.next(2); // logs: 2
  *
- * assert.deepStrictEqual(mut_history, [1, 2]);
+ * assert.deepStrictEqual(valueHistory, [1, 2]);
  *
  * num$.next(2); // nothing logged
  *
+ * num$.next(1); // logs: 1
+ *
+ * assert.deepStrictEqual(valueHistory, [1, 2, 1]);
+ *
+ * num$.next(2); // logs: 2
+ *
+ * assert.deepStrictEqual(valueHistory, [1, 2, 1, 2]);
+ *
  * num$.next(3); // logs: 3
  *
- * assert.deepStrictEqual(mut_history, [1, 2, 3]);
+ * assert.deepStrictEqual(valueHistory, [1, 2, 1, 2, 3]);
+ *
+ * num$.next(2); // logs: 2
+ *
+ * assert.deepStrictEqual(valueHistory, [1, 2, 1, 2, 3, 2]);
  * ```
  */
 export const skipIfNoChange = <A,>(
@@ -92,12 +104,12 @@ class SkipIfNoChangeObservableClass<A>
     this.#eq = eq;
   }
 
-  override tryUpdate(updaterSymbol: UpdaterSymbol): void {
+  override tryUpdate(updateToken: UpdateToken): void {
     const par = this.parents[0];
 
     const sn = par.getSnapshot();
 
-    if (par.updaterSymbol !== updaterSymbol || Optional.isNone(sn)) {
+    if (par.updateToken !== updateToken || Optional.isNone(sn)) {
       return; // skip update
     }
 
@@ -109,7 +121,7 @@ class SkipIfNoChangeObservableClass<A>
     this.#mut_previousValue = sn;
 
     if (cond) {
-      this.setNext(sn.value, updaterSymbol);
+      this.setNext(sn.value, updateToken);
     }
   }
 }

package/src/core/operators/skip-until.mts

@@ -4,7 +4,7 @@ import {
   type DropInitialValueOperator,
   type Observable,
   type SkipUntilOperatorObservable,
-  type UpdaterSymbol,
+  type UpdateToken,
 } from '../types/index.mjs';
 
 /**
@@ -34,27 +34,27 @@ import {
  *
  * const skipped$ = num$.pipe(skipUntil(startNotifier));
  *
- * const mut_history: number[] = [];
+ * const valueHistory: number[] = [];
  *
  * skipped$.subscribe((x) => {
- *   mut_history.push(x);
+ *   valueHistory.push(x);
  * });
  *
  * num$.next(1); // nothing logged
  *
  * num$.next(2); // nothing logged
  *
- * assert.deepStrictEqual(mut_history, []);
+ * assert.deepStrictEqual(valueHistory, []);
  *
  * start_();
  *
  * num$.next(4); // logs: 4
  *
- * assert.deepStrictEqual(mut_history, [4]);
+ * assert.deepStrictEqual(valueHistory, [4]);
  *
  * num$.next(5); // logs: 5
  *
- * assert.deepStrictEqual(mut_history, [4, 5]);
+ * assert.deepStrictEqual(valueHistory, [4, 5]);
  * ```
  */
 export const skipUntil =
@@ -86,19 +86,19 @@ class SkipUntilObservableClass<A>
     );
   }
 
-  override tryUpdate(updaterSymbol: UpdaterSymbol): void {
+  override tryUpdate(updateToken: UpdateToken): void {
     const par = this.parents[0];
 
     const sn = par.getSnapshot();
 
     if (
-      par.updaterSymbol !== updaterSymbol ||
+      par.updateToken !== updateToken ||
       Optional.isNone(sn) ||
       this.#mut_isSkipping
     ) {
       return; // skip update
     }
 
-    this.setNext(sn.value, updaterSymbol);
+    this.setNext(sn.value, updateToken);
   }
 }

package/src/core/operators/skip-while.mts

@@ -4,7 +4,7 @@ import {
   type DropInitialValueOperator,
   type Observable,
   type SkipWhileOperatorObservable,
-  type UpdaterSymbol,
+  type UpdateToken,
 } from '../types/index.mjs';
 
 /**
@@ -19,9 +19,9 @@ import {
  * ```ts
  * //  Timeline:
  * //
- * //  num$        1     2     3     4     5     6     7
- * //  skipped$                      5     6     7
- * //              |---- skip -----|
+ * //  num$        1     2     3     4     5     6     7     1     2
+ * //  skipped$                            5     6     7     1     2
+ * //              |-------- skip --------|
  * //
  * //  Explanation:
  * //  - skipWhile skips values while the predicate returns true
@@ -32,27 +32,37 @@ import {
  *
  * const skipped$ = num$.pipe(skipWhile((x) => x < 5));
  *
- * const mut_history: number[] = [];
+ * const valueHistory: number[] = [];
  *
  * skipped$.subscribe((x) => {
- *   mut_history.push(x);
+ *   valueHistory.push(x);
  * });
  *
  * num$.next(1); // nothing logged
  *
  * num$.next(2); // nothing logged
  *
+ * num$.next(3); // nothing logged
+ *
+ * num$.next(4); // nothing logged
+ *
  * num$.next(5); // logs: 5
  *
- * assert.deepStrictEqual(mut_history, [5]);
+ * assert.deepStrictEqual(valueHistory, [5]);
  *
  * num$.next(6); // logs: 6
  *
- * assert.deepStrictEqual(mut_history, [5, 6]);
+ * assert.deepStrictEqual(valueHistory, [5, 6]);
  *
  * num$.next(7); // logs: 7
  *
- * assert.deepStrictEqual(mut_history, [5, 6, 7]);
+ * assert.deepStrictEqual(valueHistory, [5, 6, 7]);
+ *
+ * num$.next(1); // logs: 1
+ *
+ * num$.next(2); // logs: 2
+ *
+ * assert.deepStrictEqual(valueHistory, [5, 6, 7, 1, 2]);
  * ```
  */
 export const skipWhile =
@@ -70,6 +80,7 @@ class SkipWhileObservableClass<A>
 {
   readonly #predicate: (value: A, index: SafeUint | -1) => boolean;
   #mut_index: SafeUint | -1;
+  #mut_skipping: boolean;
 
   constructor(
     parentObservable: Observable<A>,
@@ -89,14 +100,16 @@ class SkipWhileObservableClass<A>
     this.#mut_index = -1;
 
     this.#predicate = predicate;
+
+    this.#mut_skipping = true;
   }
 
-  override tryUpdate(updaterSymbol: UpdaterSymbol): void {
+  override tryUpdate(updateToken: UpdateToken): void {
     const par = this.parents[0];
 
     const sn = par.getSnapshot();
 
-    if (par.updaterSymbol !== updaterSymbol || Optional.isNone(sn)) {
+    if (par.updateToken !== updateToken || Optional.isNone(sn)) {
       return; // skip update
     }
 
@@ -104,7 +117,11 @@ class SkipWhileObservableClass<A>
       this.#mut_index === -1 ? asSafeUint(0) : SafeUint.add(1, this.#mut_index);
 
     if (!this.#predicate(sn.value, this.#mut_index)) {
-      this.setNext(sn.value, updaterSymbol);
+      this.#mut_skipping = false;
+    }
+
+    if (!this.#mut_skipping) {
+      this.setNext(sn.value, updateToken);
     }
   }
 }

package/src/core/operators/switch-map.mts

@@ -5,7 +5,7 @@ import {
   type Observable,
   type Subscription,
   type SwitchMapOperatorObservable,
-  type UpdaterSymbol,
+  type UpdateToken,
 } from '../types/index.mjs';
 
 /**
@@ -21,50 +21,81 @@ import {
  * ```ts
  * //  Timeline:
  * //
- * //  searchQuery$  "a"       "ab"      "abc"
- * //  requests      fetch1    fetch2    fetch3
- * //  results$                cancel    cancel    result3
- * //                          fetch1    fetch2
+ * //  input$      A                          B              C
+ * //  inner A     A1    A2    A3
+ * //  inner B                                B1    B2      (switched!)
+ * //  inner C                                              C1    C2    C3
+ * //  result$     A1    A2    A3              B1    B2      C1    C2    C3
  * //
  * //  Explanation:
- * //  - switchMap cancels previous inner observables when a new value arrives
- * //  - Only the result from the latest search query is emitted
- * //  - Previous ongoing requests are cancelled
- * //  - Ideal for search-as-you-type scenarios
+ * //  - switchMap creates an inner observable for each source value
+ * //  - When a new source value arrives, the previous inner is unsubscribed
+ * //  - A's inner completes normally (all 3 values emitted)
+ * //  - B's inner is interrupted by C (only 2 values emitted)
+ * //  - C's inner completes normally (all 3 values emitted)
  *
- * const searchQuery$ = source<string>();
+ * const input$ = source<string>();
  *
- * const results$ = searchQuery$.pipe(
- *   switchMap((query) => {
- *     const result$ = source<string[]>();
+ * const result$ = input$.pipe(
+ *   switchMap((letter) => {
+ *     const inner$ = source<string>();
  *
  *     setTimeout(() => {
- *       result$.next([query]);
- *
- *       result$.complete();
+ *       inner$.next(`${letter}1`);
  *     }, 10);
  *
- *     return result$;
+ *     setTimeout(() => {
+ *       inner$.next(`${letter}2`);
+ *     }, 110);
+ *
+ *     setTimeout(() => {
+ *       inner$.next(`${letter}3`);
+ *     }, 210);
+ *
+ *     return inner$;
  *   }),
  * );
  *
- * const mut_history: string[][] = [];
+ * const valueHistory: string[] = [];
  *
- * results$.subscribe((value) => {
- *   mut_history.push(value);
+ * result$.subscribe((value) => {
+ *   valueHistory.push(value);
  * });
  *
- * searchQuery$.next('a');
+ * const sleep = (ms: number): Promise<void> =>
+ *   new Promise((resolve) => {
+ *     setTimeout(resolve, ms);
+ *   });
  *
- * searchQuery$.next('ab');
+ * // Emit A - inner emits A1, A2, A3 at 10ms, 110ms, 210ms
+ * input$.next('A');
  *
- * searchQuery$.next('abc');
+ * await sleep(250);
  *
- * await new Promise((resolve) => {
- *   setTimeout(resolve, 200);
- * });
+ * assert.deepStrictEqual(valueHistory, ['A1', 'A2', 'A3']);
+ *
+ * // Emit B - inner starts emitting B1, B2 at 10ms, 110ms
+ * input$.next('B');
+ *
+ * await sleep(150);
+ *
+ * assert.deepStrictEqual(valueHistory, ['A1', 'A2', 'A3', 'B1', 'B2']);
+ *
+ * // Emit C - switches away from B (B3 cancelled), C's inner starts
+ * input$.next('C');
+ *
+ * await sleep(250);
  *
- * assert.deepStrictEqual(mut_history, [['abc']]);
+ * assert.deepStrictEqual(valueHistory, [
+ *   'A1',
+ *   'A2',
+ *   'A3',
+ *   'B1',
+ *   'B2',
+ *   'C1',
+ *   'C2',
+ *   'C3',
+ * ]);
  * ```
  *
  * @note To improve code readability, consider using `createState` instead of `switchMap`,
@@ -101,12 +132,12 @@ class SwitchMapObservableClass<A, B>
     this.#mut_subscription = undefined;
   }
 
-  override tryUpdate(updaterSymbol: UpdaterSymbol): void {
+  override tryUpdate(updateToken: UpdateToken): void {
     const par = this.parents[0];
 
     const sn = par.getSnapshot();
 
-    if (par.updaterSymbol !== updaterSymbol || Optional.isNone(sn)) {
+    if (par.updateToken !== updateToken || Optional.isNone(sn)) {
       return; // skip update
     }