synstate 0.1.2 → 1.0.0

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,59 @@
-import { mapWithIndex } from '../../operators/index.mjs';
+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 { 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>> =>

package/src/core/predefined/operators/map-result-err.mts

@@ -1,7 +1,54 @@
 import { Result } from 'ts-data-forge';
+import { map } from '../../operators/index.mjs';
 import { type KeepInitialValueOperator } from '../../types/index.mjs';
-import { map } from './map.mjs';
 
+/**
+ * Transforms the error value (`Err`) of a `Result` type emitted by the source.
+ * If the value is `Err`, the mapping function is applied; if `Ok`, it remains unchanged.
+ *
+ * @template R - The Result type from the source
+ * @template E2 - The type of the mapped error value
+ * @param mapFn - A function to transform the Err value
+ * @returns An operator that maps the Err side of Result emissions
+ *
+ * @example
+ * ```ts
+ * //  Timeline:
+ * //
+ * //  result$   Ok(1)    Err("bad")      Err("fail")
+ * //  mapped$   Ok(1)    Err("BAD")      Err("FAIL")
+ * //
+ * //  Explanation:
+ * //  - mapResultErr transforms the Err value of Result emissions
+ * //  - Ok values pass through unchanged
+ *
+ * const result$ = source<Result<number, string>>();
+ *
+ * const mapped$ = result$.pipe(mapResultErr((e) => e.toUpperCase()));
+ *
+ * const valueHistory: Result<number, string>[] = [];
+ *
+ * mapped$.subscribe((v) => {
+ *   valueHistory.push(v);
+ * });
+ *
+ * result$.next(Result.ok(1));
+ *
+ * assert.deepStrictEqual(valueHistory, [Result.ok(1)]);
+ *
+ * result$.next(Result.err('bad'));
+ *
+ * assert.deepStrictEqual(valueHistory, [Result.ok(1), Result.err('BAD')]);
+ *
+ * result$.next(Result.err('fail'));
+ *
+ * assert.deepStrictEqual(valueHistory, [
+ *   Result.ok(1),
+ *   Result.err('BAD'),
+ *   Result.err('FAIL'),
+ * ]);
+ * ```
+ */
 export const mapResultErr = <R extends UnknownResult, E2>(
   mapFn: (x: Result.UnwrapErr<R>) => E2,
 ): KeepInitialValueOperator<R, Result<Result.UnwrapOk<R>, E2>> =>

package/src/core/predefined/operators/map-result-ok.mts

@@ -1,7 +1,54 @@
 import { Result } from 'ts-data-forge';
+import { map } from '../../operators/index.mjs';
 import { type KeepInitialValueOperator } from '../../types/index.mjs';
-import { map } from './map.mjs';
 
+/**
+ * Transforms the success value (`Ok`) of a `Result` type emitted by the source.
+ * If the value is `Ok`, the mapping function is applied; if `Err`, it remains unchanged.
+ *
+ * @template R - The Result type from the source
+ * @template S2 - The type of the mapped success value
+ * @param mapFn - A function to transform the Ok value
+ * @returns An operator that maps the Ok side of Result emissions
+ *
+ * @example
+ * ```ts
+ * //  Timeline:
+ * //
+ * //  result$   Ok(2)      Err("e")   Ok(5)
+ * //  doubled$  Ok(4)      Err("e")   Ok(10)
+ * //
+ * //  Explanation:
+ * //  - mapResultOk transforms the Ok value of Result emissions
+ * //  - Err values pass through unchanged
+ *
+ * const result$ = source<Result<number, string>>();
+ *
+ * const doubled$ = result$.pipe(mapResultOk((x) => x * 2));
+ *
+ * const valueHistory: Result<number, string>[] = [];
+ *
+ * doubled$.subscribe((v) => {
+ *   valueHistory.push(v);
+ * });
+ *
+ * result$.next(Result.ok(2));
+ *
+ * assert.deepStrictEqual(valueHistory, [Result.ok(4)]);
+ *
+ * result$.next(Result.err('e'));
+ *
+ * assert.deepStrictEqual(valueHistory, [Result.ok(4), Result.err('e')]);
+ *
+ * result$.next(Result.ok(5));
+ *
+ * assert.deepStrictEqual(valueHistory, [
+ *   Result.ok(4),
+ *   Result.err('e'),
+ *   Result.ok(10),
+ * ]);
+ * ```
+ */
 export const mapResultOk = <R extends UnknownResult, S2>(
   mapFn: (x: Result.UnwrapOk<R>) => S2,
 ): KeepInitialValueOperator<R, Result<S2, Result.UnwrapErr<R>>> =>

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

@@ -1,5 +1,45 @@
+import { map } from '../../operators/index.mjs';
 import { type KeepInitialValueOperator } from '../../types/index.mjs';
-import { map } from './map.mjs';
 
+/**
+ * Maps all emitted values to a constant value, ignoring the source values.
+ * Equivalent to `map(() => value)`.
+ *
+ * @template A - The type of values from the source
+ * @template B - The type of the constant value
+ * @param value - The constant value to emit
+ * @returns An operator that always emits the given constant
+ *
+ * @example
+ * ```ts
+ * //  Timeline:
+ * //
+ * //  click$    MouseEvent   MouseEvent   MouseEvent
+ * //  count$    1            1            1
+ * //
+ * //  Explanation:
+ * //  - mapTo maps all emitted values to a constant value
+ * //  - Ignores the source values entirely
+ * //  - Useful for converting events to signals
+ *
+ * const click$ = source<string>();
+ *
+ * const one$ = click$.pipe(mapTo(1));
+ *
+ * const valueHistory: number[] = [];
+ *
+ * one$.subscribe((value) => {
+ *   valueHistory.push(value);
+ * });
+ *
+ * click$.next('click1');
+ *
+ * click$.next('click2');
+ *
+ * click$.next('click3');
+ *
+ * assert.deepStrictEqual(valueHistory, [1, 1, 1]);
+ * ```
+ */
 export const mapTo = <A, B>(value: B): KeepInitialValueOperator<A, B> =>
   map(() => value);

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

@@ -1,6 +1,45 @@
+import { map } from '../../operators/index.mjs';
 import { type KeepInitialValueOperator } from '../../types/index.mjs';
-import { map } from './map.mjs';
 
+/**
+ * Extracts a property value from each emitted object by key.
+ * Equivalent to `map(value => value[key])`.
+ *
+ * @template A - The type of the emitted object
+ * @template K - The key to extract
+ * @param key - The property key to pluck
+ * @returns An operator that emits the property value
+ *
+ * @example
+ * ```ts
+ * //  Timeline:
+ * //
+ * //  user$   { name: "Alice", age: 25 }   { name: "Bob", age: 30 }
+ * //  name$   "Alice"                       "Bob"
+ * //
+ * //  Explanation:
+ * //  - getKey extracts a property value from each emitted object
+ * //  - Equivalent to map(value => value[key])
+ *
+ * const user$ = source<Readonly<{ name: string; age: number }>>();
+ *
+ * const name$ = user$.pipe(getKey('name'));
+ *
+ * const valueHistory: string[] = [];
+ *
+ * name$.subscribe((n) => {
+ *   valueHistory.push(n);
+ * });
+ *
+ * user$.next({ name: 'Alice', age: 25 });
+ *
+ * assert.deepStrictEqual(valueHistory, ['Alice']);
+ *
+ * user$.next({ name: 'Bob', age: 30 });
+ *
+ * assert.deepStrictEqual(valueHistory, ['Alice', 'Bob']);
+ * ```
+ */
 export const pluck = <A, K extends keyof A>(
   key: K,
 ): KeepInitialValueOperator<A, A[K]> => map((a) => a[key]);

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

@@ -2,6 +2,53 @@ import { PositiveSafeInt } from 'ts-data-forge';
 import { skipWhile } from '../../operators/index.mjs';
 import { type DropInitialValueOperator } from '../../types/index.mjs';
 
+/**
+ * Skips the first `n` emissions from the source observable.
+ * After `n` values are skipped, all subsequent values pass through.
+ *
+ * @template A - The type of values from the source
+ * @param n - The number of values to skip
+ * @returns An operator that skips the first n emissions
+ *
+ * @example
+ * ```ts
+ * //  Timeline:
+ * //
+ * //  num$      1     2     3     4     5
+ * //  skipped$              3     4     5
+ * //            |skip 2|
+ * //
+ * //  Explanation:
+ * //  - skip ignores the first n emissions from the source
+ * //  - After n values are skipped, all subsequent values pass through
+ *
+ * const num$ = source<number>();
+ *
+ * const skipped$ = num$.pipe(skip(2));
+ *
+ * const valueHistory: number[] = [];
+ *
+ * skipped$.subscribe((x) => {
+ *   valueHistory.push(x);
+ * });
+ *
+ * num$.next(1); // skipped
+ *
+ * num$.next(2); // skipped
+ *
+ * assert.deepStrictEqual(valueHistory, []);
+ *
+ * num$.next(3); // logs: 3
+ *
+ * assert.deepStrictEqual(valueHistory, [3]);
+ *
+ * num$.next(4); // logs: 4
+ *
+ * num$.next(5); // logs: 5
+ *
+ * assert.deepStrictEqual(valueHistory, [3, 4, 5]);
+ * ```
+ */
 export const skip = <A,>(
   n: PositiveSafeIntWithSmallInt,
 ): DropInitialValueOperator<A, A> =>

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

@@ -1,6 +1,47 @@
 import { takeWhile } from '../../operators/index.mjs';
 import { type DropInitialValueOperator } from '../../types/index.mjs';
 
+/**
+ * Takes only the first `n` emissions from the source observable, then completes.
+ *
+ * @template A - The type of values from the source
+ * @param n - The number of values to take
+ * @returns An operator that takes the first n emissions
+ *
+ * @example
+ * ```ts
+ * //  Timeline:
+ * //
+ * //  num$    1     2     3     4 (ignored)
+ * //  taken$  1     2     3     | (completes)
+ * //
+ * //  Explanation:
+ * //  - take emits only the first n values, then completes
+ * //  - Subsequent emissions from the source are ignored
+ *
+ * const num$ = source<number>();
+ *
+ * const taken$ = num$.pipe(take(3));
+ *
+ * const valueHistory: number[] = [];
+ *
+ * taken$.subscribe((x) => {
+ *   valueHistory.push(x);
+ * });
+ *
+ * num$.next(1);
+ *
+ * num$.next(2);
+ *
+ * num$.next(3);
+ *
+ * assert.deepStrictEqual(valueHistory, [1, 2, 3]);
+ *
+ * num$.next(4); // ignored (already completed)
+ *
+ * assert.deepStrictEqual(valueHistory, [1, 2, 3]);
+ * ```
+ */
 export const take = <A,>(
   n: PositiveSafeIntWithSmallInt,
 ): DropInitialValueOperator<A, A> => takeWhile((_, index) => index + 1 <= n);

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

@@ -1,7 +1,47 @@
 import { Optional } from 'ts-data-forge';
+import { map } from '../../operators/index.mjs';
 import { type KeepInitialValueOperator } from '../../types/index.mjs';
-import { map } from './map.mjs';
 
+/**
+ * Unwraps `Optional` values, converting `Some(value)` to `value` and `None` to `undefined`.
+ *
+ * @template O - The Optional type from the source
+ * @returns An operator that unwraps Optional emissions
+ *
+ * @example
+ * ```ts
+ * //  Timeline:
+ * //
+ * //  opt$        Some(42)    None        Some(7)
+ * //  unwrapped$  42          undefined   7
+ * //
+ * //  Explanation:
+ * //  - unwrapOptional converts Some(value) to value, and None to undefined
+ * //  - Useful for extracting raw values from Optional streams
+ *
+ * const opt$ = source<Optional<number>>();
+ *
+ * const unwrapped$ = opt$.pipe(unwrapOptional());
+ *
+ * const valueHistory: (number | undefined)[] = [];
+ *
+ * unwrapped$.subscribe((v) => {
+ *   valueHistory.push(v);
+ * });
+ *
+ * opt$.next(Optional.some(42));
+ *
+ * assert.deepStrictEqual(valueHistory, [42]);
+ *
+ * opt$.next(Optional.none);
+ *
+ * assert.deepStrictEqual(valueHistory, [42, undefined]);
+ *
+ * opt$.next(Optional.some(7));
+ *
+ * assert.deepStrictEqual(valueHistory, [42, undefined, 7]);
+ * ```
+ */
 export const unwrapOptional = <
   O extends UnknownOptional,
 >(): KeepInitialValueOperator<O, Optional.Unwrap<O> | undefined> =>