synstate 0.1.1 → 1.0.0

package/src/core/create/{interval.mts → counter.mts}

@@ -1,12 +1,12 @@
 import { asSafeUint, Optional, SafeUint } from 'ts-data-forge';
 import { RootObservableClass } from '../class/index.mjs';
-import { type IntervalObservable } from '../types/index.mjs';
+import { type CounterObservable, type TimerId } from '../types/index.mjs';
 
 /**
  * Creates an observable that emits incremental numbers at a specified interval.
  * Starts with 0 immediately after subscription, then emits 1, 2, 3, ... every interval.
  *
- * @param milliSeconds - The interval duration in milliseconds
+ * @param intervalMilliSeconds - The interval duration in milliseconds
  * @param startManually - If true, waits for manual start (default: false)
  * @returns An observable that emits sequential numbers
  *
@@ -18,16 +18,16 @@ import { type IntervalObservable } from '../types/index.mjs';
  * //  tick$     0     1     2     3     4     5     ...
  * //
  * //  Explanation:
- * //  - interval emits incrementing numbers at specified intervals
+ * //  - counter emits incrementing numbers at specified intervals
  * //  - Starts at 0 and continues indefinitely
  * //  - Useful for periodic tasks or animations
  *
- * const tick$ = interval(100);
+ * const tick$ = counter(100);
  *
- * const mut_history: number[] = [];
+ * const valueHistory: number[] = [];
  *
  * const subscription = tick$.subscribe((count) => {
- *   mut_history.push(count);
+ *   valueHistory.push(count);
  * });
  *
  * await new Promise((resolve) => {
@@ -36,35 +36,40 @@ import { type IntervalObservable } from '../types/index.mjs';
  *
  * subscription.unsubscribe();
  *
- * assert.isTrue(Arr.isArrayAtLeastLength(mut_history, 3));
+ * assert.isTrue(Arr.isArrayAtLeastLength(valueHistory, 3));
  *
- * assert.deepStrictEqual(mut_history[0], 0);
+ * assert.deepStrictEqual(valueHistory[0], 0);
  *
- * assert.deepStrictEqual(mut_history[1], 1);
+ * assert.deepStrictEqual(valueHistory[1], 1);
  *
- * assert.deepStrictEqual(mut_history[2], 2);
+ * assert.deepStrictEqual(valueHistory[2], 2);
  * ```
  */
-export const interval = (
-  milliSeconds: number,
-  startManually?: boolean,
-): IntervalObservable =>
-  new IntervalObservableClass(milliSeconds, startManually);
-
-class IntervalObservableClass
+export const counter = (
+  intervalMilliSeconds: number,
+  options?: Readonly<{
+    startManually?: boolean;
+  }>,
+): CounterObservable =>
+  new CounterObservableClass(
+    intervalMilliSeconds,
+    options?.startManually ?? false,
+  );
+
+class CounterObservableClass
   extends RootObservableClass<SafeUint>
-  implements IntervalObservable
+  implements CounterObservable
 {
-  readonly #milliSeconds: number;
+  readonly #intervalMilliSeconds: number;
   #mut_counter: SafeUint;
   #mut_timerId0: TimerId | undefined;
   #mut_timerId: TimerId | undefined;
   #mut_isStarted: boolean;
 
-  constructor(milliSeconds: number, startManually?: boolean) {
+  constructor(intervalMilliSeconds: number, startManually: boolean) {
     super({ initialValue: Optional.none });
 
-    this.#milliSeconds = milliSeconds;
+    this.#intervalMilliSeconds = intervalMilliSeconds;
 
     this.#mut_counter = asSafeUint(0);
 
@@ -74,27 +79,26 @@ class IntervalObservableClass
 
     this.#mut_isStarted = false;
 
-    if (startManually !== true) {
+    if (!startManually) {
       this.start();
     }
   }
 
-  start(): this {
+  start(): void {
     if (this.#mut_isStarted) {
       console.warn('cannot start twice');
 
-      return this;
+      return;
     }
 
     this.#mut_isStarted = true;
 
     if (this.isCompleted) {
-      console.warn('cannot restart stopped IntervalObservable');
+      console.warn('cannot restart stopped CounterObservable');
 
-      return this;
+      return;
     }
 
-    // emit zero
     this.#mut_timerId0 = setTimeout(() => {
       this.startUpdate(this.#mut_counter);
     }, 0);
@@ -103,9 +107,7 @@ class IntervalObservableClass
       this.#mut_counter = SafeUint.add(1, this.#mut_counter);
 
       this.startUpdate(this.#mut_counter);
-    }, this.#milliSeconds);
-
-    return this;
+    }, this.#intervalMilliSeconds);
   }
 
   #resetTimer(): void {

package/src/core/create/from-abortable-promise.mts

@@ -0,0 +1,83 @@
+import { Optional, Result } from 'ts-data-forge';
+import { RootObservableClass } from '../class/index.mjs';
+import { type FromPromiseObservable } from '../types/index.mjs';
+
+/**
+ * Creates an observable from a Promise factory that receives an `AbortSignal`.
+ * When the observable is completed (e.g., by `switchMap` switching to a new
+ * inner observable), the `AbortController` is automatically aborted, cancelling
+ * the in-flight request.
+ *
+ * Emits `Result.ok(value)` when the promise resolves, or `Result.err(error)`
+ * when it rejects. Rejections caused by abort (`AbortError`) are silently
+ * ignored and do not emit.
+ *
+ * @template A - The type of the resolved value
+ * @template E - The type of the error (excluding AbortError)
+ * @param factory - A function that receives an `AbortSignal` and returns a Promise
+ * @returns An observable that emits the promise result
+ *
+ * @example
+ * ```ts
+ * const results$ = query.pipe(
+ *   switchMap((q) =>
+ *     fromAbortablePromise((signal) =>
+ *       fetch(`/api/search?q=${q}`, { signal }).then((r) => r.json()),
+ *     ),
+ *   ),
+ * );
+ * ```
+ */
+export const fromAbortablePromise = <A, E = unknown>(
+  // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+  factory: (signal: AbortSignal) => Promise<A>,
+): FromPromiseObservable<A, E> =>
+  new FromAbortablePromiseObservableClass(factory);
+
+class FromAbortablePromiseObservableClass<A, E = unknown>
+  extends RootObservableClass<Result<A, E>>
+  implements FromPromiseObservable<A, E>
+{
+  readonly #abortController: AbortController;
+
+  // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+  constructor(factory: (signal: AbortSignal) => Promise<A>) {
+    super({ initialValue: Optional.none });
+
+    this.#abortController = new AbortController();
+
+    const promise = factory(this.#abortController.signal);
+
+    promise
+      .then((value) => {
+        if (this.isCompleted) return;
+
+        this.startUpdate(Result.ok(value));
+      })
+      .catch((error: unknown) => {
+        if (this.isCompleted) return;
+
+        // Silently ignore AbortError — it means the observable was
+        // intentionally completed (e.g., by switchMap).
+        if (error instanceof DOMException && error.name === 'AbortError') {
+          return;
+        }
+
+        this.startUpdate(
+          Result.err(
+            // eslint-disable-next-line total-functions/no-unsafe-type-assertion
+            error as E,
+          ),
+        );
+      })
+      .finally(() => {
+        this.complete();
+      });
+  }
+
+  override complete(): void {
+    this.#abortController.abort();
+
+    super.complete();
+  }
+}

package/src/core/create/from-promise.mts

@@ -16,7 +16,7 @@ import { type FromPromiseObservable } from '../types/index.mjs';
  * //  Timeline:
  * //
  * //  promise     [pending...]  -> resolved/rejected
- * //  data$                     Ok(value) or Err(error)
+ * //  data$                        Ok(value) or Err(error)
  * //
  * //  Explanation:
  * //  - fromPromise converts a Promise into an observable
@@ -24,17 +24,20 @@ import { type FromPromiseObservable } from '../types/index.mjs';
  * //  - Completes after emitting the result
  * //  - Useful for integrating async operations into reactive flows
  *
- * const fetchData = async (): Promise<{ value: number }> => ({ value: 42 });
+ * const fetchData = async (): Promise<Readonly<{ value: number }>> =>
+ *   ({
+ *     value: 42,
+ *   }) as const;
  *
  * const data$ = fromPromise(fetchData());
  *
- * const mut_history: { value: number }[] = [];
+ * const valueHistory: Readonly<{ value: number }>[] = [];
  *
  * await new Promise<void>((resolve) => {
  *   data$.subscribe(
  *     (result) => {
  *       if (Result.isOk(result)) {
- *         mut_history.push(result.value);
+ *         valueHistory.push(result.value);
  *       }
  *     },
  *     () => {
@@ -43,18 +46,18 @@ import { type FromPromiseObservable } from '../types/index.mjs';
  *   );
  * });
  *
- * assert.deepStrictEqual(mut_history, [{ value: 42 }]);
+ * assert.deepStrictEqual(valueHistory, [{ value: 42 }]);
  * ```
  */
 export const fromPromise = <A, E = unknown>(
-  promise: Readonly<Promise<A>>,
+  promise: Promise<A>,
 ): FromPromiseObservable<A, E> => new FromPromiseObservableClass(promise);
 
 class FromPromiseObservableClass<A, E = unknown>
   extends RootObservableClass<Result<A, E>>
   implements FromPromiseObservable<A, E>
 {
-  constructor(promise: Readonly<Promise<A>>) {
+  constructor(promise: Promise<A>) {
     super({ initialValue: Optional.none });
 
     promise

package/src/core/create/from-subscribable.mts

@@ -41,17 +41,17 @@ import {
  *
  *     return { unsubscribe: () => {} };
  *   },
- * };
+ * } as const;
  *
  * const observable$ = fromSubscribable<number>(customSubscribable);
  *
- * const mut_history: number[] = [];
+ * const valueHistory: number[] = [];
  *
  * await new Promise<void>((resolve) => {
  *   observable$.subscribe(
  *     (result) => {
  *       if (Result.isOk(result)) {
- *         mut_history.push(result.value);
+ *         valueHistory.push(result.value);
  *       }
  *     },
  *     () => {
@@ -60,7 +60,7 @@ import {
  *   );
  * });
  *
- * assert.deepStrictEqual(mut_history, [1, 2, 3]);
+ * assert.deepStrictEqual(valueHistory, [1, 2, 3]);
  * ```
  */
 export const fromSubscribable = <A, E = unknown>(

package/src/core/create/index.mts

@@ -1,7 +1,7 @@
-export * from './from-array.mjs';
+export * from './counter.mjs';
+export * from './from-abortable-promise.mjs';
 export * from './from-promise.mjs';
 export * from './from-subscribable.mjs';
-export * from './interval.mjs';
-export * from './of.mjs';
+export * from './just.mjs';
 export * from './source.mjs';
 export * from './timer.mjs';

package/src/core/create/just.mts

@@ -0,0 +1,43 @@
+import { Optional } from 'ts-data-forge';
+import { RootObservableClass } from '../class/index.mjs';
+import { type InitializedRootObservable } from '../types/index.mjs';
+
+/**
+ * Creates an Observable that holds a single static value and immediately
+ * completes. Useful inside `switchMap` to emit a fallback value when no
+ * asynchronous work is needed.
+ *
+ * @template A - The type of the value
+ * @param value - The value to emit
+ * @returns An initialized Observable that holds the value and is already completed
+ *
+ * @example
+ * ```ts
+ * const greeting$ = just('hello');
+ *
+ * const valueHistory: string[] = [];
+ *
+ * greeting$.subscribe(
+ *   (value) => {
+ *     valueHistory.push(value);
+ *   },
+ *   () => {
+ *     // onComplete — called immediately since just() completes right away
+ *   },
+ * );
+ *
+ * assert.deepStrictEqual(valueHistory, ['hello']);
+ *
+ * assert.strictEqual(greeting$.isCompleted, true);
+ * ```
+ */
+export const just = <const A,>(value: A): InitializedRootObservable<A> => {
+  const obs = new RootObservableClass<A>({
+    initialValue: Optional.some(value),
+  });
+
+  obs.complete();
+
+  // eslint-disable-next-line total-functions/no-unsafe-type-assertion
+  return obs as InitializedRootObservable<A>;
+};

package/src/core/create/source.mts

@@ -25,39 +25,35 @@ import {
  *
  * const count$ = source<number>();
  *
- * const mut_history: number[] = [];
+ * const valueHistory: number[] = [];
  *
  * count$.subscribe((value) => {
- *   mut_history.push(value);
+ *   valueHistory.push(value);
  * });
  *
  * count$.next(1); // logs: 1
  *
- * assert.deepStrictEqual(mut_history, [1]);
+ * assert.deepStrictEqual(valueHistory, [1]);
  *
  * count$.next(2); // logs: 2
  *
- * assert.deepStrictEqual(mut_history, [1, 2]);
+ * assert.deepStrictEqual(valueHistory, [1, 2]);
  *
  * count$.next(3); // logs: 3
  *
- * assert.deepStrictEqual(mut_history, [1, 2, 3]);
+ * assert.deepStrictEqual(valueHistory, [1, 2, 3]);
  * ```
  */
-export function source<A>(initialValue: A): InitializedSourceObservable<A>;
+export function source<const A>(
+  initialValue: A,
+): InitializedSourceObservable<A>;
 
-export function source<A>(): SourceObservable<A>;
+export function source<const A>(): SourceObservable<A>;
 
-export function source<A>(...args: readonly A[]): SourceObservable<A> {
+export function source<const A>(...args: readonly A[]): SourceObservable<A> {
   return new SourceObservableClass<A>(...args);
 }
 
-/**
- * Alias for `source()`. Creates a new Observable source.
- * @see source
- */
-export const subject = source; // alias
-
 class SourceObservableClass<A>
   extends RootObservableClass<A>
   implements SourceObservable<A>

package/src/core/create/timer.mts

@@ -1,6 +1,6 @@
 import { Optional } from 'ts-data-forge';
 import { RootObservableClass } from '../class/index.mjs';
-import { type TimerObservable } from '../types/index.mjs';
+import { type TimerId, type TimerObservable } from '../types/index.mjs';
 
 /**
  * Creates an observable that emits 0 after a specified delay and then completes.
@@ -22,12 +22,12 @@ import { type TimerObservable } from '../types/index.mjs';
  *
  * const delayed$ = timer(100);
  *
- * const mut_history: number[] = [];
+ * const valueHistory: number[] = [];
  *
  * await new Promise<void>((resolve) => {
  *   delayed$.subscribe(
  *     () => {
- *       mut_history.push(1);
+ *       valueHistory.push(1);
  *     },
  *     () => {
  *       resolve();
@@ -35,13 +35,16 @@ import { type TimerObservable } from '../types/index.mjs';
  *   );
  * });
  *
- * assert.deepStrictEqual(mut_history, [1]);
+ * assert.deepStrictEqual(valueHistory, [1]);
  * ```
  */
 export const timer = (
   milliSeconds: number,
-  startManually: boolean = false,
-): TimerObservable => new TimerObservableClass(milliSeconds, startManually);
+  options?: Readonly<{
+    startManually?: boolean;
+  }>,
+): TimerObservable =>
+  new TimerObservableClass(milliSeconds, options?.startManually ?? false);
 
 class TimerObservableClass
   extends RootObservableClass<0>
@@ -65,11 +68,11 @@ class TimerObservableClass
     }
   }
 
-  start(): this {
+  start(): void {
     if (this.#mut_isStarted) {
       console.warn('cannot start twice');
 
-      return this;
+      return;
     }
 
     this.#mut_isStarted = true;
@@ -77,7 +80,7 @@ class TimerObservableClass
     if (this.isCompleted) {
       console.warn('cannot restart stopped TimerObservable');
 
-      return this;
+      return;
     }
 
     this.#mut_timerId = setTimeout(() => {
@@ -85,8 +88,6 @@ class TimerObservableClass
 
       this.complete();
     }, this.#milliSeconds);
-
-    return this;
   }
 
   #resetTimer(): void {

package/src/core/index.mts

@@ -2,5 +2,5 @@ export * from './class/index.mjs';
 export * from './combine/index.mjs';
 export * from './create/index.mjs';
 export * from './operators/index.mjs';
+export * from './predefined/index.mjs';
 export * from './types/index.mjs';
-export * from './utils/index.mjs';

package/src/core/operators/audit.mts

@@ -0,0 +1,172 @@
+import { Optional } from 'ts-data-forge';
+import { AsyncChildObservableClass } from '../class/index.mjs';
+import {
+  type AuditOperatorObservable,
+  type KeepInitialValueOperator,
+  type Observable,
+  type TimerId,
+  type UpdateToken,
+} from '../types/index.mjs';
+
+/**
+ * Ignores source values for duration milliseconds, then emits the most recent value from the source Observable, then repeats this process.
+ *
+ * Unlike `throttle` which emits the first value, `audit` emits the last value.
+ *
+ * @template A - The type of values from the source
+ * @param milliSeconds - The audit time window in milliseconds
+ * @returns An operator that audits emissions from the observable
+ *
+ * @example
+ * ```ts
+ * //  Timeline (250ms audit):
+ * //
+ * //  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 ->
+ * //  audited$               2           3                   11          14   (emitted at end of window)
+ * //
+ * //  Explanation:
+ * //  - audit emits the LAST value received during each time window
+ * //  - Unlike throttle (which emits the FIRST value), audit emits the LAST
+ * //  - Useful when you want the most recent value after a burst of events
+ *
+ * const input$ = source<number>();
+ *
+ * const audited$ = input$.pipe(audit(250));
+ *
+ * const valueHistory: number[] = [];
+ *
+ * audited$.subscribe((value) => {
+ *   valueHistory.push(value);
+ * });
+ *
+ * const sleep = (ms: number): Promise<void> =>
+ *   new Promise((resolve) => {
+ *     setTimeout(resolve, ms);
+ *   });
+ *
+ * input$.next(0);
+ *
+ * await sleep(200);
+ *
+ * input$.next(2);
+ *
+ * assert.deepStrictEqual(valueHistory, []);
+ *
+ * await sleep(100);
+ *
+ * assert.deepStrictEqual(valueHistory, [2]);
+ *
+ * input$.next(3);
+ *
+ * await sleep(300);
+ *
+ * assert.deepStrictEqual(valueHistory, [2, 3]);
+ *
+ * await sleep(300);
+ *
+ * input$.next(9);
+ *
+ * await sleep(100);
+ *
+ * input$.next(10);
+ *
+ * await sleep(100);
+ *
+ * input$.next(11);
+ *
+ * assert.deepStrictEqual(valueHistory, [2, 3]);
+ *
+ * await sleep(100);
+ *
+ * assert.deepStrictEqual(valueHistory, [2, 3, 11]);
+ *
+ * input$.next(12);
+ *
+ * await sleep(100);
+ *
+ * input$.next(13);
+ *
+ * assert.deepStrictEqual(valueHistory, [2, 3, 11]);
+ *
+ * await sleep(100);
+ *
+ * input$.next(14);
+ *
+ * assert.deepStrictEqual(valueHistory, [2, 3, 11]);
+ *
+ * await sleep(100);
+ *
+ * assert.deepStrictEqual(valueHistory, [2, 3, 11, 14]);
+ * ```
+ */
+export const audit = <A,>(
+  milliSeconds: number,
+): KeepInitialValueOperator<A, A> =>
+  // eslint-disable-next-line total-functions/no-unsafe-type-assertion
+  ((parentObservable) =>
+    new AuditObservableClass(
+      parentObservable,
+      milliSeconds,
+    )) as KeepInitialValueOperator<A, A>;
+
+class AuditObservableClass<A>
+  extends AsyncChildObservableClass<A, readonly [A]>
+  implements AuditOperatorObservable<A>
+{
+  readonly #milliSeconds: number;
+  #mut_timerId: TimerId | undefined;
+  #mut_isSkipping: boolean;
+
+  constructor(parentObservable: Observable<A>, milliSeconds: number) {
+    super({
+      parents: [parentObservable],
+      initialValue: parentObservable.getSnapshot(),
+    });
+
+    this.#mut_isSkipping = false;
+
+    this.#mut_timerId = undefined;
+
+    this.#milliSeconds = milliSeconds;
+  }
+
+  override tryUpdate(updateToken: UpdateToken): void {
+    const par = this.parents[0];
+
+    if (
+      par.updateToken !== updateToken ||
+      Optional.isNone(par.getSnapshot()) ||
+      this.#mut_isSkipping
+    ) {
+      return; // skip update
+    }
+
+    // set timer
+    this.#mut_isSkipping = true;
+
+    this.#mut_timerId = setTimeout(() => {
+      const sn = par.getSnapshot();
+
+      if (Optional.isNone(sn)) return;
+
+      this.startUpdate(sn.value);
+
+      this.#mut_isSkipping = false;
+    }, this.#milliSeconds);
+  }
+
+  #resetTimer(): void {
+    if (this.#mut_timerId !== undefined) {
+      clearTimeout(this.#mut_timerId);
+    }
+  }
+
+  override complete(): void {
+    this.#resetTimer();
+
+    super.complete();
+  }
+}