synstate 0.1.2 → 1.0.1

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

@@ -4,7 +4,7 @@ import {
   type KeepInitialValueOperator,
   type Observable,
   type TakeUntilOperatorObservable,
-  type UpdaterSymbol,
+  type UpdateToken,
 } from '../types/index.mjs';
 
 /**
@@ -34,25 +34,25 @@ import {
  *
  * const limited$ = num$.pipe(takeUntil(stopNotifier));
  *
- * const mut_history: number[] = [];
+ * const valueHistory: number[] = [];
  *
  * limited$.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(2); // logs: 2
  *
- * assert.deepStrictEqual(mut_history, [1, 2]);
+ * assert.deepStrictEqual(valueHistory, [1, 2]);
  *
  * stop_();
  *
  * num$.next(3); // nothing logged (completed)
  *
- * assert.deepStrictEqual(mut_history, [1, 2]);
+ * assert.deepStrictEqual(valueHistory, [1, 2]);
  * ```
  */
 export const takeUntil = <A,>(
@@ -85,15 +85,15 @@ class TakeUntilObservableClass<A>
     );
   }
 
-  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
     }
 
-    this.setNext(sn.value, updaterSymbol);
+    this.setNext(sn.value, updateToken);
   }
 }

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

@@ -12,7 +12,7 @@ import {
   type InitializedObservable,
   type Observable,
   type TakeWhileOperatorObservable,
-  type UpdaterSymbol,
+  type UpdateToken,
 } from '../types/index.mjs';
 import { withInitialValue } from './with-initial-value.mjs';
 
@@ -28,7 +28,7 @@ import { withInitialValue } from './with-initial-value.mjs';
  * ```ts
  * //  Timeline:
  * //
- * //  num$      1     2     3     4     5     6 (ignored)
+ * //  num$      1     2     3     4     5     6     1     2 (ignored)
  * //  taken$    1     2     3     4     | (completes)
  * //
  * //  Explanation:
@@ -40,27 +40,35 @@ import { withInitialValue } from './with-initial-value.mjs';
  *
  * const taken$ = num$.pipe(takeWhile((x) => x < 5));
  *
- * const mut_history: number[] = [];
+ * const valueHistory: number[] = [];
  *
  * taken$.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(2); // logs: 2
  *
- * assert.deepStrictEqual(mut_history, [1, 2]);
+ * num$.next(3); // logs: 3
+ *
+ * num$.next(4); // logs: 4
+ *
+ * assert.deepStrictEqual(valueHistory, [1, 2, 3, 4]);
  *
  * num$.next(5); // nothing logged (completes)
  *
- * assert.deepStrictEqual(mut_history, [1, 2]);
+ * assert.deepStrictEqual(valueHistory, [1, 2, 3, 4]);
  *
  * num$.next(6); // nothing logged (already completed)
  *
- * assert.deepStrictEqual(mut_history, [1, 2]);
+ * assert.deepStrictEqual(valueHistory, [1, 2, 3, 4]);
+ *
+ * num$.next(1); // logs: 1
+ *
+ * assert.deepStrictEqual(valueHistory, [1, 2, 3, 4]);
  * ```
  */
 export const takeWhile =
@@ -99,12 +107,12 @@ class TakeWhileObservableClass<A>
     this.#predicate = predicate;
   }
 
-  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
     }
 
@@ -112,7 +120,7 @@ class TakeWhileObservableClass<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.setNext(sn.value, updateToken);
     } else {
       this.complete();
     }

package/src/core/operators/{throttle-time.mts → throttle.mts}

@@ -3,8 +3,9 @@ import { SyncChildObservableClass } from '../class/index.mjs';
 import {
   type KeepInitialValueOperator,
   type Observable,
-  type ThrottleTimeOperatorObservable,
-  type UpdaterSymbol,
+  type ThrottleOperatorObservable,
+  type TimerId,
+  type UpdateToken,
 } from '../types/index.mjs';
 
 /**
@@ -17,68 +18,87 @@ import {
  *
  * @example
  * ```ts
- * //  Timeline (1000ms throttle):
+ * //  Timeline (250ms throttle):
  * //
- * //  Time(ms)  0    100   200   300   ...   1000  1100  1200  ...   2000  2100
- * //  scroll$   e1   e2    e3    e4          e5    e6    e7          e8    e9
- * //  throttled$ e1                          e5                      e8
- * //             |-------1000ms------>       |------1000ms------>    |------1000ms------>
+ * //  Time(x50ms)  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0
+ * //
+ * //  input$       0       2   3                   9   10  11  12  13  14
+ * //               |- 250ms -> |- 250ms ->         |- 250ms ->    |- 250ms ->
+ * //  throttled$   0           3                   9          12           (emitted at start of window)
  * //
  * //  Explanation:
- * //  - throttleTime emits the first value immediately, then ignores subsequent values
- * //    for the specified duration (1000ms)
- * //  - At 0ms: e1 is emitted immediately
- * //  - At 100-300ms: e2, e3, e4 are ignored (within 1000ms window)
- * //  - At 1000ms: e5 is emitted (1000ms has passed since e1)
- * //  - At 1100-1200ms: e6, e7 are ignored
- * //  - At 2000ms: e8 is emitted (1000ms has passed since e5)
+ * //  - throttle emits the FIRST value received, then ignores subsequent values
+ * //    for the specified duration (250ms)
+ * //  - Unlike audit (which emits the LAST value), throttle emits the FIRST
+ * //  - Useful for rate-limiting scroll/resize events
  *
- * const scroll$ = source<number>();
+ * const input$ = source<number>();
  *
- * const throttled$ = scroll$.pipe(throttleTime(200));
+ * const throttled$ = input$.pipe(throttle(250));
  *
- * const mut_history: number[] = [];
+ * const valueHistory: number[] = [];
  *
  * throttled$.subscribe((value) => {
- *   mut_history.push(value);
+ *   valueHistory.push(value);
  * });
  *
- * scroll$.next(1);
+ * const sleep = (ms: number): Promise<void> =>
+ *   new Promise((resolve) => {
+ *     setTimeout(resolve, ms);
+ *   });
  *
- * assert.deepStrictEqual(mut_history, [1]);
+ * input$.next(0);
  *
- * await new Promise((resolve) => {
- *   setTimeout(resolve, 50);
- * });
+ * assert.deepStrictEqual(valueHistory, [0]);
  *
- * scroll$.next(2);
+ * await sleep(200);
  *
- * scroll$.next(3);
+ * input$.next(2);
  *
- * assert.deepStrictEqual(mut_history, [1]);
+ * assert.deepStrictEqual(valueHistory, [0]);
  *
- * await new Promise((resolve) => {
- *   setTimeout(resolve, 200);
- * });
+ * await sleep(100);
+ *
+ * input$.next(3);
+ *
+ * assert.deepStrictEqual(valueHistory, [0, 3]);
+ *
+ * await sleep(300);
+ *
+ * input$.next(9);
+ *
+ * assert.deepStrictEqual(valueHistory, [0, 3, 9]);
+ *
+ * await sleep(100);
+ *
+ * input$.next(10);
+ *
+ * await sleep(100);
+ *
+ * input$.next(11);
+ *
+ * assert.deepStrictEqual(valueHistory, [0, 3, 9]);
+ *
+ * await sleep(100);
  *
- * scroll$.next(4);
+ * input$.next(12);
  *
- * assert.deepStrictEqual(mut_history, [1, 4]);
+ * assert.deepStrictEqual(valueHistory, [0, 3, 9, 12]);
  * ```
  */
-export const throttleTime = <A,>(
+export const throttle = <A,>(
   milliSeconds: number,
 ): KeepInitialValueOperator<A, A> =>
   // eslint-disable-next-line total-functions/no-unsafe-type-assertion
   ((parentObservable) =>
-    new ThrottleTimeObservableClass(
+    new ThrottleObservableClass(
       parentObservable,
       milliSeconds,
     )) as KeepInitialValueOperator<A, A>;
 
-class ThrottleTimeObservableClass<A>
+class ThrottleObservableClass<A>
   extends SyncChildObservableClass<A, readonly [A]>
-  implements ThrottleTimeOperatorObservable<A>
+  implements ThrottleOperatorObservable<A>
 {
   readonly #milliSeconds: number;
   #mut_timerId: TimerId | undefined;
@@ -97,20 +117,20 @@ class ThrottleTimeObservableClass<A>
     this.#milliSeconds = milliSeconds;
   }
 
-  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);
 
     this.#mut_isSkipping = true;
 

package/src/core/operators/with-buffered-from.mts

@@ -3,7 +3,7 @@ import { SyncChildObservableClass } from '../class/index.mjs';
 import {
   type KeepInitialValueOperator,
   type Observable,
-  type UpdaterSymbol,
+  type UpdateToken,
   type WithBufferedFromOperatorObservable,
 } from '../types/index.mjs';
 import { maxDepth } from '../utils/index.mjs';
@@ -37,27 +37,27 @@ import { maxDepth } from '../utils/index.mjs';
  *
  * const result$ = trigger$.pipe(withBufferedFrom(data$));
  *
- * const mut_history: (readonly [number, readonly string[]])[] = [];
+ * const valueHistory: (readonly [number, readonly string[]])[] = [];
  *
  * result$.subscribe(([triggerValue, bufferedData]) => {
- *   mut_history.push([triggerValue, bufferedData]);
+ *   valueHistory.push([triggerValue, bufferedData]);
  * });
  *
- * data$.next('a');
+ * data$.next('A');
  *
- * data$.next('b');
+ * data$.next('B');
  *
  * trigger$.next(1);
  *
- * assert.deepStrictEqual(mut_history, [[1, ['a', 'b']]]);
+ * assert.deepStrictEqual(valueHistory, [[1, ['A', 'B']]]);
  *
- * data$.next('c');
+ * data$.next('C');
  *
  * trigger$.next(2);
  *
- * assert.deepStrictEqual(mut_history, [
- *   [1, ['a', 'b']],
- *   [2, ['c']],
+ * assert.deepStrictEqual(valueHistory, [
+ *   [1, ['A', 'B']],
+ *   [2, ['C']],
  * ]);
  * ```
  */
@@ -105,16 +105,16 @@ class WithBufferedFromObservableClass<A, B>
     });
   }
 
-  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
     }
 
-    this.setNext([sn.value, this.#mut_bufferedValues], updaterSymbol);
+    this.setNext([sn.value, this.#mut_bufferedValues], updateToken);
 
     this.#clearBuffer();
   }

package/src/core/operators/with-current-value-from.mts

@@ -3,7 +3,7 @@ import { SyncChildObservableClass } from '../class/index.mjs';
 import {
   type DropInitialValueOperator,
   type Observable,
-  type UpdaterSymbol,
+  type UpdateToken,
   type WithCurrentValueFromOperatorObservable,
 } from '../types/index.mjs';
 import { maxDepth } from '../utils/index.mjs';
@@ -22,14 +22,15 @@ import { maxDepth } from '../utils/index.mjs';
  * //  Timeline:
  * //
  * //  name$     "Alice"           "Bob"               "Charlie"
- * //  age$                25              30      35              40
- * //  result$             ["Alice",25]  ["Bob",30]  ["Bob",35]  ["Charlie",40]
+ * //  age$                25              30
+ * //  result$   (skip)          ["Bob",25]           ["Charlie",30]
  * //
  * //  Explanation:
  * //  - withCurrentValueFrom samples the current value from another observable
- * //  - Emits a tuple [sourceValue, sampledValue] each time the source emits
+ * //  - Emits a tuple [sourceValue, sampledValue] each time the SOURCE emits
+ * //  - Does NOT emit when the sampled observable (age$) emits
  * //  - Does not emit until both observables have emitted at least once
- * //  - Similar to combine, but only emits when the source (not the sampled) emits
+ * //  - "Alice" is skipped because age$ hasn't emitted yet
  *
  * const name$ = source<string>();
  *
@@ -37,27 +38,27 @@ import { maxDepth } from '../utils/index.mjs';
  *
  * const result$ = name$.pipe(withCurrentValueFrom(age$));
  *
- * const mut_history: (readonly [string, number])[] = [];
+ * const valueHistory: (readonly [string, number])[] = [];
  *
  * result$.subscribe(([name_, currentAge]) => {
- *   mut_history.push([name_, currentAge]);
+ *   valueHistory.push([name_, currentAge]);
  * });
  *
  * name$.next('Alice'); // nothing logged (age$ hasn't emitted)
  *
- * assert.deepStrictEqual(mut_history, []);
+ * assert.deepStrictEqual(valueHistory, []);
  *
  * age$.next(25);
  *
  * name$.next('Bob'); // logs: Bob is 25 years old
  *
- * assert.deepStrictEqual(mut_history, [['Bob', 25]]);
+ * assert.deepStrictEqual(valueHistory, [['Bob', 25]]);
  *
  * age$.next(30);
  *
  * name$.next('Charlie'); // logs: Charlie is 30 years old
  *
- * assert.deepStrictEqual(mut_history, [
+ * assert.deepStrictEqual(valueHistory, [
  *   ['Bob', 25],
  *   ['Charlie', 30],
  * ]);
@@ -99,12 +100,12 @@ class WithCurrentValueFromObservableClass<A, B>
     this.#observable = observable;
   }
 
-  override tryUpdate(updaterSymbol: UpdaterSymbol): void {
+  override tryUpdate(updateToken: UpdateToken): void {
     const par = this.parents[0];
 
     const ps = par.getSnapshot();
 
-    if (par.updaterSymbol !== updaterSymbol || Optional.isNone(ps)) {
+    if (par.updateToken !== updateToken || Optional.isNone(ps)) {
       return; // skip update
     }
 
@@ -112,6 +113,6 @@ class WithCurrentValueFromObservableClass<A, B>
 
     if (Optional.isNone(curr)) return; // skip update
 
-    this.setNext([ps.value, curr.value], updaterSymbol);
+    this.setNext([ps.value, curr.value], updateToken);
   }
 }

package/src/core/operators/with-initial-value.mts

@@ -4,7 +4,7 @@ import { source } from '../create/index.mjs';
 import {
   type InitializedObservable,
   type Observable,
-  type UpdaterSymbol,
+  type UpdateToken,
   type WithInitialValueOperator,
   type WithInitialValueOperatorObservable,
 } from '../types/index.mjs';
@@ -37,21 +37,21 @@ import {
  *
  * const initialized$ = num$.pipe(withInitialValue(0));
  *
- * const mut_history: number[] = [];
+ * const valueHistory: number[] = [];
  *
  * initialized$.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: 2
  *
- * assert.deepStrictEqual(mut_history, [0, 1, 2]);
+ * assert.deepStrictEqual(valueHistory, [0, 1, 2]);
  * ```
  */
 export const withInitialValue =
@@ -70,16 +70,16 @@ class WithInitialValueObservableClass<A, I>
     });
   }
 
-  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
     }
 
-    this.setNext(sn.value, updaterSymbol);
+    this.setNext(sn.value, updateToken);
   }
 }
 

package/src/core/predefined/operators/attach-index.mts

@@ -1,10 +1,60 @@
-import { mapWithIndex } from '../../operators/index.mjs';
+import { type SafeUint } from 'ts-type-forge';
+import { map } from '../../operators/index.mjs';
 import { type KeepInitialValueOperator } from '../../types/index.mjs';
 
+/**
+ * Attaches a sequential index to each emitted value, producing `[index, value]` tuples.
+ * Index starts at 0 and increments with each emission.
+ *
+ * @template A - The type of values from the source
+ * @returns An operator that emits `[index, value]` tuples
+ *
+ * @example
+ * ```ts
+ * //  Timeline:
+ * //
+ * //  letter$    "A"      "B"      "C"
+ * //  indexed$   [0,"A"]  [1,"B"]  [2,"C"]
+ * //
+ * //  Explanation:
+ * //  - attachIndex attaches a sequential index to each emitted value
+ * //  - Produces [index, value] tuples
+ * //  - Index starts at 0 and increments with each emission
+ *
+ * const letter$ = source<string>();
+ *
+ * const indexed$ = letter$.pipe(attachIndex());
+ *
+ * const valueHistory: (readonly [number, string])[] = [];
+ *
+ * indexed$.subscribe(([i, letter]) => {
+ *   valueHistory.push([i, letter]);
+ * });
+ *
+ * letter$.next('A');
+ *
+ * assert.deepStrictEqual(valueHistory, [[0, 'A']]);
+ *
+ * letter$.next('B');
+ *
+ * assert.deepStrictEqual(valueHistory, [
+ *   [0, 'A'],
+ *   [1, 'B'],
+ * ]);
+ *
+ * letter$.next('C');
+ *
+ * assert.deepStrictEqual(valueHistory, [
+ *   [0, 'A'],
+ *   [1, 'B'],
+ *   [2, 'C'],
+ * ]);
+ * ```
+ */
 export const withIndex = <A,>(): KeepInitialValueOperator<
   A,
   readonly [SafeUint | -1, A]
-> => mapWithIndex((a, i) => [i, a] as const);
+> => map((a, i) => [i, a] as const);
 
 /**
  * Alias for `withIndex`.

package/src/core/predefined/operators/index.mts

@@ -3,7 +3,6 @@ export * from './map-optional.mjs';
 export * from './map-result-err.mjs';
 export * from './map-result-ok.mjs';
 export * from './map-to.mjs';
-export * from './map.mjs';
 export * from './pluck.mjs';
 export * from './skip.mjs';
 export * from './take.mjs';

package/src/core/predefined/operators/map-optional.mts

@@ -1,7 +1,54 @@
-import { Optional } from 'ts-data-forge';
+import { Optional, type UnknownOptional } from 'ts-data-forge';
+import { map } from '../../operators/index.mjs';
 import { type KeepInitialValueOperator } from '../../types/index.mjs';
-import { map } from './map.mjs';
 
+/**
+ * Transforms the inner value of an `Optional` type emitted by the source.
+ * If the value is `Some`, the mapping function is applied; if `None`, it remains `None`.
+ *
+ * @template O - The Optional type from the source
+ * @template B - The type of the mapped inner value
+ * @param mapFn - A function to transform the unwrapped value
+ * @returns An operator that maps the inner value of Optional emissions
+ *
+ * @example
+ * ```ts
+ * //  Timeline:
+ * //
+ * //  value$    Some(2)    None       Some(5)
+ * //  doubled$  Some(4)    None       Some(10)
+ * //
+ * //  Explanation:
+ * //  - mapOptional transforms the inner value of Optional emissions
+ * //  - Some values are mapped; None values pass through unchanged
+ *
+ * const value$ = source<Optional<number>>();
+ *
+ * const doubled$ = value$.pipe(mapOptional((x) => x * 2));
+ *
+ * const valueHistory: Optional<number>[] = [];
+ *
+ * doubled$.subscribe((v) => {
+ *   valueHistory.push(v);
+ * });
+ *
+ * value$.next(Optional.some(2));
+ *
+ * assert.deepStrictEqual(valueHistory, [Optional.some(4)]);
+ *
+ * value$.next(Optional.none);
+ *
+ * assert.deepStrictEqual(valueHistory, [Optional.some(4), Optional.none]);
+ *
+ * value$.next(Optional.some(5));
+ *
+ * assert.deepStrictEqual(valueHistory, [
+ *   Optional.some(4),
+ *   Optional.none,
+ *   Optional.some(10),
+ * ]);
+ * ```
+ */
 export const mapOptional = <O extends UnknownOptional, B>(
   mapFn: (x: Optional.Unwrap<O>) => B,
 ): KeepInitialValueOperator<O, Optional<B>> =>