synstate 0.1.1 → 1.0.0

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

@@ -0,0 +1,51 @@
+import { map } from '../../operators/index.mjs';
+import { type KeepInitialValueOperator } from '../../types/index.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]);
+
+/**
+ * Alias for `pluck`.
+ * @see pluck
+ */
+export const getKey = pluck;

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

@@ -0,0 +1,57 @@
+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> =>
+  !PositiveSafeInt.is(n) ? idFn : skipWhile((_, index) => index + 1 <= n);
+
+const idFn = <T,>(value: T): T => value;

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

@@ -0,0 +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

@@ -0,0 +1,49 @@
+import { Optional } from 'ts-data-forge';
+import { map } from '../../operators/index.mjs';
+import { type KeepInitialValueOperator } from '../../types/index.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> =>
+  // eslint-disable-next-line total-functions/no-unsafe-type-assertion
+  map(Optional.unwrap as Fn<O, Optional.Unwrap<O> | undefined>);

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

@@ -0,0 +1,48 @@
+import { Result } from 'ts-data-forge';
+import { map } from '../../operators/index.mjs';
+import { type KeepInitialValueOperator } from '../../types/index.mjs';
+
+/**
+ * Unwraps the error value from a `Result`, converting `Err(error)` to `error` and `Ok` to `undefined`.
+ *
+ * @template R - The Result type from the source
+ * @returns An operator that unwraps the Err side of Result emissions
+ *
+ * @example
+ * ```ts
+ * //  Timeline:
+ * //
+ * //  result$     Ok(1)      Err("fail")   Ok(2)
+ * //  unwrapped$  undefined  "fail"        undefined
+ * //
+ * //  Explanation:
+ * //  - unwrapResultErr converts Err(error) to error, and Ok to undefined
+ * //  - Useful for extracting error values from Result streams
+ *
+ * const result$ = source<Result<number, string>>();
+ *
+ * const unwrapped$ = result$.pipe(unwrapResultErr());
+ *
+ * const valueHistory: (string | undefined)[] = [];
+ *
+ * unwrapped$.subscribe((v) => {
+ *   valueHistory.push(v);
+ * });
+ *
+ * result$.next(Result.ok(1));
+ *
+ * assert.deepStrictEqual(valueHistory, [undefined]);
+ *
+ * result$.next(Result.err('fail'));
+ *
+ * assert.deepStrictEqual(valueHistory, [undefined, 'fail']);
+ *
+ * result$.next(Result.ok(2));
+ *
+ * assert.deepStrictEqual(valueHistory, [undefined, 'fail', undefined]);
+ * ```
+ */
+export const unwrapResultErr = <
+  R extends UnknownResult,
+>(): KeepInitialValueOperator<R, Result.UnwrapErr<R> | undefined> =>
+  map(Result.unwrapErr as Fn<R, Result.UnwrapErr<R> | undefined>);

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

@@ -0,0 +1,49 @@
+import { Result } from 'ts-data-forge';
+import { map } from '../../operators/index.mjs';
+import { type KeepInitialValueOperator } from '../../types/index.mjs';
+
+/**
+ * Unwraps the success value from a `Result`, converting `Ok(value)` to `value` and `Err` to `undefined`.
+ *
+ * @template R - The Result type from the source
+ * @returns An operator that unwraps the Ok side of Result emissions
+ *
+ * @example
+ * ```ts
+ * //  Timeline:
+ * //
+ * //  result$     Ok(42)    Err("e")    Ok(7)
+ * //  unwrapped$  42        undefined   7
+ * //
+ * //  Explanation:
+ * //  - unwrapResultOk converts Ok(value) to value, and Err to undefined
+ * //  - Useful for extracting success values from Result streams
+ *
+ * const result$ = source<Result<number, string>>();
+ *
+ * const unwrapped$ = result$.pipe(unwrapResultOk());
+ *
+ * const valueHistory: (number | undefined)[] = [];
+ *
+ * unwrapped$.subscribe((v) => {
+ *   valueHistory.push(v);
+ * });
+ *
+ * result$.next(Result.ok(42));
+ *
+ * assert.deepStrictEqual(valueHistory, [42]);
+ *
+ * result$.next(Result.err('e'));
+ *
+ * assert.deepStrictEqual(valueHistory, [42, undefined]);
+ *
+ * result$.next(Result.ok(7));
+ *
+ * assert.deepStrictEqual(valueHistory, [42, undefined, 7]);
+ * ```
+ */
+export const unwrapResultOk = <
+  R extends UnknownResult,
+>(): KeepInitialValueOperator<R, Result.UnwrapOk<R> | undefined> =>
+  // eslint-disable-next-line total-functions/no-unsafe-type-assertion
+  map(Result.unwrapOk as Fn<R, Result.UnwrapOk<R> | undefined>);

package/src/core/types/id.mts

@@ -2,4 +2,4 @@ export type ObservableId = Brand<symbol, 'observable-id'>;
 
 export type SubscriberId = Brand<symbol, 'subscriber-id'>;
 
-export type UpdaterSymbol = Brand<symbol, 'updater-symbol'>;
+export type UpdateToken = Brand<symbol, 'update-token'>;

package/src/core/types/index.mts

@@ -2,4 +2,5 @@ export * from './id.mjs';
 export * from './observable-family.mjs';
 export * from './observable-kind.mjs';
 export * from './observable.mjs';
+export * from './timer.mjs';
 export * from './types.mjs';

package/src/core/types/observable-family.mts

@@ -23,16 +23,6 @@ export type SourceObservable<A> = Readonly<{
 }> &
   RootObservable<A>;
 
-export type OfObservable<A> = Readonly<{
-  emit: () => OfObservable<A>;
-}> &
-  RootObservable<A>;
-
-export type FromArrayObservable<A> = Readonly<{
-  emit: () => FromArrayObservable<A>;
-}> &
-  RootObservable<A>;
-
 export type FromPromiseObservable<A, E = unknown> = RootObservable<
   Result<A, E>
 >;
@@ -41,13 +31,13 @@ export type FromSubscribableObservable<A, E = unknown> = RootObservable<
   Result<A, E>
 >;
 
-export type IntervalObservable = Readonly<{
-  start: () => IntervalObservable;
+export type CounterObservable = Readonly<{
+  start: () => void;
 }> &
   RootObservable<SafeUint>;
 
 export type TimerObservable = Readonly<{
-  start: () => TimerObservable;
+  start: () => void;
 }> &
   RootObservable<0>;
 
@@ -77,7 +67,7 @@ namespace SynStateInternals {
     ? true
     : false;
 
-  /** Evaluates True | false as true instead of boolean */
+  /** Evaluates true | false as true instead of boolean */
   type LogicalValue<B extends boolean> = readonly [B] extends readonly [true]
     ? true
     : readonly [B] extends readonly [false]
@@ -184,10 +174,7 @@ export type MergeObservableRefined<
   OS extends NonEmptyArray<Observable<unknown>>,
 > = SynStateInternals.MergeObservableRefinedImpl<OS>;
 
-export type MapWithIndexOperatorObservable<A, B> = SyncChildObservable<
-  B,
-  readonly [A]
->;
+export type MapOperatorObservable<A, B> = SyncChildObservable<B, readonly [A]>;
 
 export type PairwiseOperatorObservable<A> = SyncChildObservable<
   readonly [A, A],
@@ -231,19 +218,16 @@ export type SkipIfNoChangeOperatorObservable<A> = SyncChildObservable<
   readonly [A]
 >;
 
-export type ThrottleTimeOperatorObservable<A> = SyncChildObservable<
+export type ThrottleOperatorObservable<A> = SyncChildObservable<
   A,
   readonly [A]
 >;
 
 // AsyncChildObservable
 
-export type AuditTimeOperatorObservable<A> = AsyncChildObservable<
-  A,
-  readonly [A]
->;
+export type AuditOperatorObservable<A> = AsyncChildObservable<A, readonly [A]>;
 
-export type DebounceTimeOperatorObservable<A> = AsyncChildObservable<
+export type DebounceOperatorObservable<A> = AsyncChildObservable<
   A,
   readonly [A]
 >;

package/src/core/types/observable.mts

@@ -1,5 +1,5 @@
 import { expectType, type Optional } from 'ts-data-forge';
-import { type ObservableId, type UpdaterSymbol } from './id.mjs';
+import { type ObservableId, type UpdateToken } from './id.mjs';
 import { type ObservableKind } from './observable-kind.mjs';
 import { type NonEmptyUnknownList, type Subscription } from './types.mjs';
 
@@ -28,12 +28,12 @@ type CreateObservableType<A, Kind extends ObservableKind> = Readonly<{
   // state
   getSnapshot: () => Optional<A>;
   isCompleted: boolean;
-  updaterSymbol: UpdaterSymbol;
+  updateToken: UpdateToken;
   hasSubscriber: boolean;
   hasChild: boolean;
   hasActiveChild: () => boolean;
 
-  tryUpdate: (updaterSymbol: UpdaterSymbol) => void;
+  tryUpdate: (updateToken: UpdateToken) => void;
   tryComplete: () => void;
   complete: () => void;
   subscribe: (onNext: (v: A) => void, onComplete?: () => void) => Subscription;

package/src/core/types/timer.mts

@@ -0,0 +1,2 @@
+// Timer types for Node.js/Browser compatibility
+export type TimerId = ReturnType<typeof setTimeout>;

package/src/core/utils/id-maker.mts

@@ -1,7 +1,7 @@
 import {
   type ObservableId,
   type SubscriberId,
-  type UpdaterSymbol,
+  type UpdateToken,
 } from '../types/index.mjs';
 
 function* idMaker<T extends symbol>(): Generator<T, T, T> {
@@ -19,7 +19,7 @@ const observableIdMaker = idMaker<ObservableId>();
 
 const subscriberIdMaker = idMaker<SubscriberId>();
 
-const updaterSymbolMaker = idMaker<UpdaterSymbol>();
+const updateTokenMaker = idMaker<UpdateToken>();
 
 export const issueObservableId = (): ObservableId =>
   observableIdMaker.next().value;
@@ -27,5 +27,5 @@ export const issueObservableId = (): ObservableId =>
 export const issueSubscriberId = (): SubscriberId =>
   subscriberIdMaker.next().value;
 
-export const issueUpdaterSymbol = (): UpdaterSymbol =>
-  updaterSymbolMaker.next().value;
+export const issueUpdateToken = (): UpdateToken =>
+  updateTokenMaker.next().value;

package/src/globals.d.mts

@@ -1,4 +1 @@
 /// <reference types="ts-type-forge" />
-
-// Timer types for Node.js/Browser compatibility
-type TimerId = ReturnType<typeof setTimeout>;

package/src/utils/collect-to-array.mts

@@ -0,0 +1,17 @@
+import { type Observable } from '../core/index.mjs';
+
+export const collectToArray = <A,>(
+  observable: Observable<A>,
+): Promise<readonly A[]> =>
+  new Promise<readonly A[]>((resolve) => {
+    const mut_buffer: A[] = [];
+
+    observable.subscribe(
+      (value) => {
+        mut_buffer.push(value);
+      },
+      () => {
+        resolve(mut_buffer);
+      },
+    );
+  });

package/src/utils/create-boolean-state.mts

@@ -0,0 +1,68 @@
+import { type InitializedObservable } from '../core/index.mjs';
+import { createState } from './create-state.mjs';
+
+/**
+ * Creates a reactive boolean state with convenient methods for boolean operations.
+ * Extends `createState` with boolean-specific helpers like `toggle`, `setTrue`, and `setFalse`.
+ *
+ * @param initialState - The initial boolean value
+ * @returns A 2-element tuple: `[state, { setTrue, setFalse, toggle, setState, updateState, resetState, getSnapshot, initialState }]`
+ *
+ * @example
+ * ```ts
+ * import type * as React from 'react';
+ * import { createBooleanState } from 'synstate';
+ * import { useObservableValue } from 'synstate-react-hooks';
+ *
+ *     // Menu drawer open/close state.
+ *     // setTrue and setFalse can be passed directly as callbacks
+ *     // — no need to create wrapper functions like `() => setState(true)`.
+ *     const [menuOpen$, { setTrue: openMenu, setFalse: closeMenu }] =
+ *       createBooleanState(false);
+ *
+ *     const SampleComponent = (): React.JSX.Element => (
+ *       <MenuDrawer
+ *         open={useObservableValue(menuOpen$)}
+ *         onClose={closeMenu}
+ *         onOpen={openMenu}
+ *       />
+ *     );
+ * ```
+ */
+
+export const createBooleanState = (
+  initialState: boolean,
+): readonly [
+  state: InitializedObservable<boolean>,
+  Readonly<{
+    setTrue: () => void;
+    setFalse: () => void;
+    setState: (next: boolean) => boolean;
+    toggle: () => boolean;
+    updateState: (updateFn: (prev: boolean) => boolean) => boolean;
+    resetState: () => boolean;
+    getSnapshot: () => boolean;
+    initialState: boolean;
+  }>,
+] => {
+  const [state, setState, { updateState, resetState, getSnapshot }] =
+    createState(initialState);
+
+  return [
+    state,
+    {
+      setTrue: () => {
+        setState(true);
+      },
+      setFalse: () => {
+        setState(false);
+      },
+      toggle: () => updateState((s) => !s),
+      setState,
+      updateState,
+      resetState,
+      getSnapshot,
+      initialState,
+    },
+  ] as const;
+};

package/src/utils/create-event-emitter.mts

@@ -51,19 +51,19 @@ export const createEventEmitter = (): readonly [
  * ```ts
  * const [message$, emitMessage] = createValueEmitter<string>();
  *
- * const mut_history: string[] = [];
+ * const messageHistory: string[] = [];
  *
  * message$.subscribe((msg) => {
- *   mut_history.push(msg);
+ *   messageHistory.push(msg);
  * });
  *
  * emitMessage('Hello'); // logs: Hello
  *
- * assert.deepStrictEqual(mut_history, ['Hello']);
+ * assert.deepStrictEqual(messageHistory, ['Hello']);
  *
  * emitMessage('World');
  *
- * assert.deepStrictEqual(mut_history, ['Hello', 'World']);
+ * assert.deepStrictEqual(messageHistory, ['Hello', 'World']);
  * ```
  */
 export const createValueEmitter = <A,>(): readonly [

package/src/utils/create-reducer.mts

@@ -8,7 +8,7 @@ import { source, type InitializedObservable } from '../core/index.mjs';
  * @template A - The type of actions
  * @param reducer - A pure function that takes current state and action, returns new state
  * @param initialState - The initial value of the state
- * @returns An object containing the state observable, dispatch function, and snapshot getter
+ * @returns A 3-element tuple: `[state, dispatch, { getSnapshot, initialState }]`
  *
  * @example
  * ```ts
@@ -24,23 +24,23 @@ import { source, type InitializedObservable } from '../core/index.mjs';
  *   0,
  * );
  *
- * const mut_history: number[] = [];
+ * const stateHistory: number[] = [];
  *
  * state.subscribe((value: number) => {
- *   mut_history.push(value);
+ *   stateHistory.push(value);
  * });
  *
- * assert.deepStrictEqual(mut_history, [0]);
+ * assert.deepStrictEqual(stateHistory, [0]);
  *
  * dispatch({ type: 'increment' }); // logs: 1
  *
- * assert.deepStrictEqual(mut_history, [0, 1]);
+ * assert.deepStrictEqual(stateHistory, [0, 1]);
  *
  * dispatch({ type: 'increment' });
  *
  * dispatch({ type: 'decrement' });
  *
- * assert.deepStrictEqual(mut_history, [0, 1, 2, 1]);
+ * assert.deepStrictEqual(stateHistory, [0, 1, 2, 1]);
  * ```
  */
 export const createReducer = <S, A>(
@@ -49,7 +49,10 @@ export const createReducer = <S, A>(
 ): readonly [
   state: InitializedObservable<S>,
   dispatch: (action: A) => S,
-  getSnapshot: () => S,
+  Readonly<{
+    getSnapshot: () => S;
+    initialState: S;
+  }>,
 ] => {
   const state = source<S>(initialState);
 
@@ -63,5 +66,5 @@ export const createReducer = <S, A>(
 
   const getSnapshot = (): S => state.getSnapshot().value;
 
-  return [state, dispatch, getSnapshot] as const;
+  return [state, dispatch, { getSnapshot, initialState }] as const;
 };