synstate 3.0.5 → 3.1.0

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

@@ -1,8 +1,8 @@
 import { Optional, Result } from 'ts-data-forge';
 import { createRootObservable } from '../base/index.mjs';
-import {
-  type FromSubscribableObservable,
-  type Subscribable,
+import type {
+  FromSubscribableObservable,
+  Subscribable,
 } from '../types/index.mjs';
 
 /**

package/src/core/create/just.mts

@@ -1,6 +1,6 @@
 import { Optional } from 'ts-data-forge';
 import { createRootObservable } from '../base/index.mjs';
-import { type InitializedRootObservable } from '../types/index.mjs';
+import type { InitializedRootObservable } from '../types/index.mjs';
 
 /**
  * Creates an Observable that holds a single static value and immediately

package/src/core/create/source.mts

@@ -1,8 +1,8 @@
 import { Arr, Optional } from 'ts-data-forge';
 import { createRootObservable } from '../base/index.mjs';
-import {
-  type InitializedSourceObservable,
-  type SourceObservable,
+import type {
+  InitializedSourceObservable,
+  SourceObservable,
 } from '../types/index.mjs';
 
 /**

package/src/core/create/timer.mts

@@ -1,6 +1,6 @@
 import { Optional } from 'ts-data-forge';
 import { createRootObservable } from '../base/index.mjs';
-import { type TimerId, type TimerObservable } from '../types/index.mjs';
+import type { TimerId, TimerObservable } from '../types/index.mjs';
 
 /**
  * Creates an observable that emits 0 after a specified delay and then completes.

package/src/core/operators/audit.mts

@@ -1,10 +1,10 @@
 import { Optional } from 'ts-data-forge';
 import { createAsyncChildObservable } from '../base/index.mjs';
-import {
-  type AuditOperatorObservable,
-  type KeepInitialValueOperator,
-  type Observable,
-  type TimerId,
+import type {
+  AuditOperatorObservable,
+  KeepInitialValueOperator,
+  Observable,
+  TimerId,
 } from '../types/index.mjs';
 
 /**

package/src/core/operators/debounce.mts

@@ -1,10 +1,10 @@
 import { Optional } from 'ts-data-forge';
 import { createAsyncChildObservable } from '../base/index.mjs';
-import {
-  type DebounceOperatorObservable,
-  type KeepInitialValueOperator,
-  type Observable,
-  type TimerId,
+import type {
+  DebounceOperatorObservable,
+  KeepInitialValueOperator,
+  Observable,
+  TimerId,
 } from '../types/index.mjs';
 
 /**

package/src/core/operators/filter.mts

@@ -7,11 +7,11 @@ import {
 } from 'ts-data-forge';
 import { createSyncChildObservable } from '../base/index.mjs';
 import { source } from '../create/index.mjs';
-import {
-  type DropInitialValueOperator,
-  type FilterOperatorObservable,
-  type InitializedObservable,
-  type Observable,
+import type {
+  DropInitialValueOperator,
+  FilterOperatorObservable,
+  InitializedObservable,
+  Observable,
 } from '../types/index.mjs';
 import { withInitialValue } from './with-initial-value.mjs';
 

package/src/core/operators/map.mts

@@ -1,11 +1,11 @@
 import { Optional, SafeUint, asSafeUint, expectType } from 'ts-data-forge';
 import { createSyncChildObservable } from '../base/index.mjs';
 import { source } from '../create/index.mjs';
-import {
-  type InitializedObservable,
-  type KeepInitialValueOperator,
-  type MapOperatorObservable,
-  type Observable,
+import type {
+  InitializedObservable,
+  KeepInitialValueOperator,
+  MapOperatorObservable,
+  Observable,
 } from '../types/index.mjs';
 import { withInitialValue } from './with-initial-value.mjs';
 

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

@@ -1,10 +1,10 @@
 import { Arr, Optional } from 'ts-data-forge';
 import { createAsyncChildObservable } from '../base/index.mjs';
-import {
-  type DropInitialValueOperator,
-  type MergeMapOperatorObservable,
-  type Observable,
-  type Subscription,
+import type {
+  DropInitialValueOperator,
+  MergeMapOperatorObservable,
+  Observable,
+  Subscription,
 } from '../types/index.mjs';
 
 /**

package/src/core/operators/pairwise.mts

@@ -1,10 +1,10 @@
 import { Optional } from 'ts-data-forge';
-import { type FixedLengthTuple } from 'ts-type-forge';
+import type { FixedLengthTuple } from 'ts-type-forge';
 import { createSyncChildObservable } from '../base/index.mjs';
-import {
-  type DropInitialValueOperator,
-  type Observable,
-  type PairwiseOperatorObservable,
+import type {
+  DropInitialValueOperator,
+  Observable,
+  PairwiseOperatorObservable,
 } from '../types/index.mjs';
 
 /**

package/src/core/operators/scan.mts

@@ -1,9 +1,9 @@
 import { Optional } from 'ts-data-forge';
 import { createInitializedSyncChildObservable } from '../base/index.mjs';
-import {
-  type Observable,
-  type ScanOperatorObservable,
-  type WithInitialValueOperator,
+import type {
+  Observable,
+  ScanOperatorObservable,
+  WithInitialValueOperator,
 } from '../types/index.mjs';
 
 /**

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

@@ -1,9 +1,9 @@
 import { Optional } from 'ts-data-forge';
 import { createSyncChildObservable } from '../base/index.mjs';
-import {
-  type KeepInitialValueOperator,
-  type Observable,
-  type SkipIfNoChangeOperatorObservable,
+import type {
+  KeepInitialValueOperator,
+  Observable,
+  SkipIfNoChangeOperatorObservable,
 } from '../types/index.mjs';
 
 /**

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

@@ -1,9 +1,9 @@
 import { Optional } from 'ts-data-forge';
 import { createSyncChildObservable } from '../base/index.mjs';
-import {
-  type DropInitialValueOperator,
-  type Observable,
-  type SkipUntilOperatorObservable,
+import type {
+  DropInitialValueOperator,
+  Observable,
+  SkipUntilOperatorObservable,
 } from '../types/index.mjs';
 
 /**

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

@@ -1,9 +1,9 @@
 import { Optional, SafeUint, asSafeUint, pipe } from 'ts-data-forge';
 import { createSyncChildObservable } from '../base/index.mjs';
-import {
-  type DropInitialValueOperator,
-  type Observable,
-  type SkipWhileOperatorObservable,
+import type {
+  DropInitialValueOperator,
+  Observable,
+  SkipWhileOperatorObservable,
 } from '../types/index.mjs';
 
 /**

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

@@ -1,10 +1,10 @@
 import { Optional } from 'ts-data-forge';
 import { createAsyncChildObservable } from '../base/index.mjs';
-import {
-  type DropInitialValueOperator,
-  type Observable,
-  type Subscription,
-  type SwitchMapOperatorObservable,
+import type {
+  DropInitialValueOperator,
+  Observable,
+  Subscription,
+  SwitchMapOperatorObservable,
 } from '../types/index.mjs';
 
 /**

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

@@ -1,9 +1,9 @@
 import { Optional } from 'ts-data-forge';
 import { createSyncChildObservable } from '../base/index.mjs';
-import {
-  type KeepInitialValueOperator,
-  type Observable,
-  type TakeUntilOperatorObservable,
+import type {
+  KeepInitialValueOperator,
+  Observable,
+  TakeUntilOperatorObservable,
 } from '../types/index.mjs';
 
 /**

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

@@ -7,11 +7,11 @@ import {
 } from 'ts-data-forge';
 import { createSyncChildObservable } from '../base/index.mjs';
 import { source } from '../create/index.mjs';
-import {
-  type DropInitialValueOperator,
-  type InitializedObservable,
-  type Observable,
-  type TakeWhileOperatorObservable,
+import type {
+  DropInitialValueOperator,
+  InitializedObservable,
+  Observable,
+  TakeWhileOperatorObservable,
 } from '../types/index.mjs';
 import { withInitialValue } from './with-initial-value.mjs';
 

package/src/core/operators/throttle.mts

@@ -1,10 +1,10 @@
 import { Optional } from 'ts-data-forge';
 import { createSyncChildObservable } from '../base/index.mjs';
-import {
-  type KeepInitialValueOperator,
-  type Observable,
-  type ThrottleOperatorObservable,
-  type TimerId,
+import type {
+  KeepInitialValueOperator,
+  Observable,
+  ThrottleOperatorObservable,
+  TimerId,
 } from '../types/index.mjs';
 
 /**

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

@@ -1,9 +1,9 @@
 import { Arr, Optional, pipe } from 'ts-data-forge';
 import { createSyncChildObservable } from '../base/index.mjs';
-import {
-  type KeepInitialValueOperator,
-  type Observable,
-  type WithBufferedFromOperatorObservable,
+import type {
+  KeepInitialValueOperator,
+  Observable,
+  WithBufferedFromOperatorObservable,
 } from '../types/index.mjs';
 import { maxDepth } from '../utils/index.mjs';
 

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

@@ -1,9 +1,9 @@
 import { Optional, pipe } from 'ts-data-forge';
 import { createSyncChildObservable } from '../base/index.mjs';
-import {
-  type DropInitialValueOperator,
-  type Observable,
-  type WithCurrentValueFromOperatorObservable,
+import type {
+  DropInitialValueOperator,
+  Observable,
+  WithCurrentValueFromOperatorObservable,
 } from '../types/index.mjs';
 import { maxDepth } from '../utils/index.mjs';
 

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

@@ -1,11 +1,11 @@
 import { expectType, Optional } from 'ts-data-forge';
 import { createInitializedSyncChildObservable } from '../base/index.mjs';
 import { source } from '../create/index.mjs';
-import {
-  type InitializedObservable,
-  type Observable,
-  type WithInitialValueOperator,
-  type WithInitialValueOperatorObservable,
+import type {
+  InitializedObservable,
+  Observable,
+  WithInitialValueOperator,
+  WithInitialValueOperatorObservable,
 } from '../types/index.mjs';
 
 /**

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

@@ -1,6 +1,6 @@
-import { type SafeUint } from 'ts-type-forge';
+import type { SafeUint } from 'ts-type-forge';
 import { map } from '../../operators/index.mjs';
-import { type KeepInitialValueOperator } from '../../types/index.mjs';
+import type { KeepInitialValueOperator } from '../../types/index.mjs';
 
 /**
  * Attaches a sequential index to each emitted value, producing `[index, value]` tuples.

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

@@ -1,6 +1,6 @@
 import { Optional, type UnknownOptional } from 'ts-data-forge';
 import { map } from '../../operators/index.mjs';
-import { type KeepInitialValueOperator } from '../../types/index.mjs';
+import type { KeepInitialValueOperator } from '../../types/index.mjs';
 
 /**
  * Transforms the inner value of an `Optional` type emitted by the source.

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

@@ -1,6 +1,6 @@
 import { Result, type UnknownResult } from 'ts-data-forge';
 import { map } from '../../operators/index.mjs';
-import { type KeepInitialValueOperator } from '../../types/index.mjs';
+import type { KeepInitialValueOperator } from '../../types/index.mjs';
 
 /**
  * Transforms the error value (`Err`) of a `Result` type emitted by the source.

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

@@ -1,6 +1,6 @@
 import { Result, type UnknownResult } from 'ts-data-forge';
 import { map } from '../../operators/index.mjs';
-import { type KeepInitialValueOperator } from '../../types/index.mjs';
+import type { KeepInitialValueOperator } from '../../types/index.mjs';
 
 /**
  * Transforms the success value (`Ok`) of a `Result` type emitted by the source.

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

@@ -1,5 +1,5 @@
 import { map } from '../../operators/index.mjs';
-import { type KeepInitialValueOperator } from '../../types/index.mjs';
+import type { KeepInitialValueOperator } from '../../types/index.mjs';
 
 /**
  * Maps all emitted values to a constant value, ignoring the source values.

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

@@ -1,5 +1,5 @@
 import { map } from '../../operators/index.mjs';
-import { type KeepInitialValueOperator } from '../../types/index.mjs';
+import type { KeepInitialValueOperator } from '../../types/index.mjs';
 
 /**
  * Extracts a property value from each emitted object by key.

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

@@ -1,7 +1,7 @@
 import { PositiveSafeInt } from 'ts-data-forge';
-import { type PositiveSafeIntWithSmallInt } from 'ts-type-forge';
+import type { PositiveSafeIntWithSmallInt } from 'ts-type-forge';
 import { skipWhile } from '../../operators/index.mjs';
-import { type DropInitialValueOperator } from '../../types/index.mjs';
+import type { DropInitialValueOperator } from '../../types/index.mjs';
 
 /**
  * Skips the first `n` emissions from the source observable.

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

@@ -1,6 +1,6 @@
-import { type PositiveSafeIntWithSmallInt } from 'ts-type-forge';
+import type { PositiveSafeIntWithSmallInt } from 'ts-type-forge';
 import { takeWhile } from '../../operators/index.mjs';
-import { type DropInitialValueOperator } from '../../types/index.mjs';
+import type { DropInitialValueOperator } from '../../types/index.mjs';
 
 /**
  * Takes only the first `n` emissions from the source observable, then completes.

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

@@ -1,7 +1,7 @@
 import { Optional, type UnknownOptional } from 'ts-data-forge';
-import { type Fn } from 'ts-type-forge';
+import type { Fn } from 'ts-type-forge';
 import { map } from '../../operators/index.mjs';
-import { type KeepInitialValueOperator } from '../../types/index.mjs';
+import type { KeepInitialValueOperator } from '../../types/index.mjs';
 
 /**
  * Unwraps `Optional` values, converting `Some(value)` to `value` and `None` to `undefined`.

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

@@ -1,7 +1,7 @@
 import { Result, type UnknownResult } from 'ts-data-forge';
-import { type Fn } from 'ts-type-forge';
+import type { Fn } from 'ts-type-forge';
 import { map } from '../../operators/index.mjs';
-import { type KeepInitialValueOperator } from '../../types/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`.

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

@@ -1,7 +1,7 @@
 import { Result, type UnknownResult } from 'ts-data-forge';
-import { type Fn } from 'ts-type-forge';
+import type { Fn } from 'ts-type-forge';
 import { map } from '../../operators/index.mjs';
-import { type KeepInitialValueOperator } from '../../types/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`.

package/src/core/types/id.mts

@@ -1,4 +1,4 @@
-import { type Brand } from 'ts-type-forge';
+import type { Brand } from 'ts-type-forge';
 
 export type ObservableId = Brand<symbol, 'observable-id'>;
 

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

@@ -1,21 +1,21 @@
 import { expectType, type Result } from 'ts-data-forge';
-import {
-  type ArrayElement,
-  type FixedLengthTuple,
-  type NonEmptyTuple,
-  type SafeUint,
+import type {
+  ArrayElement,
+  FixedLengthTuple,
+  NonEmptyTuple,
+  SafeUint,
 } from 'ts-type-forge';
-import {
-  type AsyncChildObservable,
-  type InitializedObservable,
-  type InitializedRootObservable,
-  type InitializedSyncChildObservable,
-  type Observable,
-  type RootObservable,
-  type SyncChildObservable,
-  type Unwrap,
+import type {
+  AsyncChildObservable,
+  InitializedObservable,
+  InitializedRootObservable,
+  InitializedSyncChildObservable,
+  Observable,
+  RootObservable,
+  SyncChildObservable,
+  Unwrap,
 } from './observable.mjs';
-import { type NonEmptyUnknownList } from './types.mjs';
+import type { NonEmptyUnknownList } from './types.mjs';
 
 // RootObservable
 

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

@@ -1,4 +1,4 @@
-import { type StrictExclude } from 'ts-type-forge';
+import type { StrictExclude } from 'ts-type-forge';
 
 export type ObservableKind = 'root' | 'sync child' | 'async child';
 

package/src/core/types/observable.mts

@@ -1,8 +1,8 @@
 import { expectType, type Optional, type Some } from 'ts-data-forge';
-import { type FixedLengthTuple, type StrictOmit } from 'ts-type-forge';
-import { type ObservableId, type UpdateToken } from './id.mjs';
-import { type ObservableKind } from './observable-kind.mjs';
-import { type NonEmptyUnknownList, type Subscription } from './types.mjs';
+import type { FixedLengthTuple, StrictOmit } from 'ts-type-forge';
+import type { ObservableId, UpdateToken } from './id.mjs';
+import type { ObservableKind } from './observable-kind.mjs';
+import type { NonEmptyUnknownList, Subscription } from './types.mjs';
 
 /**
  * Inheritance

package/src/core/types/types.mts

@@ -1,5 +1,5 @@
 import { expectType, type Queue } from 'ts-data-forge';
-import { type NonEmptyTuple } from 'ts-type-forge';
+import type { NonEmptyTuple } from 'ts-type-forge';
 
 export type TupleToQueueTuple<T extends readonly unknown[]> = Readonly<{
   [P in keyof T]: Queue<T[P]>;

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

@@ -1,7 +1,7 @@
-import {
-  type ObservableId,
-  type SubscriberId,
-  type UpdateToken,
+import type {
+  ObservableId,
+  SubscriberId,
+  UpdateToken,
 } from '../types/index.mjs';
 
 function* idMaker<T extends symbol>(): Generator<T, T, T> {

package/src/core/utils/max-depth.mts

@@ -1,5 +1,5 @@
 import { Arr, Optional, pipe } from 'ts-data-forge';
-import { type Observable } from '../types/index.mjs';
+import type { Observable } from '../types/index.mjs';
 
 export const maxDepth = (parents: readonly Observable<unknown>[]): number =>
   pipe(Arr.maxBy(parents, (p) => p.depth))

package/src/core/utils/observable-utils.mts

@@ -1,4 +1,4 @@
-import { type Subscriber } from '../types/index.mjs';
+import type { Subscriber } from '../types/index.mjs';
 
 export const toSubscriber = <A,>(
   onNext: (v: A) => void,

package/src/core/utils/utils.mts

@@ -1,5 +1,5 @@
 import { Arr, asSafeInt, asUint32, SafeInt } from 'ts-data-forge';
-import { type NegativeInt32, type Uint32 } from 'ts-type-forge';
+import type { NegativeInt32, Uint32 } from 'ts-type-forge';
 
 export const halfInt = (x: SafeInt): SafeInt =>
   x % 2 === 0

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

@@ -1,4 +1,4 @@
-import { type Observable } from '../core/index.mjs';
+import type { Observable } from '../core/index.mjs';
 
 export const collectToArray = <A,>(
   observable: Observable<A>,

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

@@ -1,4 +1,5 @@
-import { type InitializedObservable } from '../core/index.mjs';
+import type { InitializedObservable } from '../core/index.mjs';
+import type { StateOptions } from './create-reducer.mjs';
 import { createState } from './create-state.mjs';
 
 /**
@@ -6,6 +7,8 @@ import { createState } from './create-state.mjs';
  * Extends `createState` with boolean-specific helpers like `toggle`, `setTrue`, and `setFalse`.
  *
  * @param initialState - The initial boolean value
+ * @param options - {@link StateOptions}: `equals`, to pass on only the
+ *   updates that change the state
  * @returns A 2-element tuple: `[state, { setTrue, setFalse, toggle, setState, updateState, resetState, getSnapshot, initialState }]`
  *
  * @example
@@ -14,24 +17,25 @@ import { createState } from './create-state.mjs';
  * 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);
+ * // 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}
- *       />
- *     );
+ * const SampleComponent = (): React.JSX.Element => (
+ *   <MenuDrawer
+ *     open={useObservableValue(menuOpen$)}
+ *     onClose={closeMenu}
+ *     onOpen={openMenu}
+ *   />
+ * );
  * ```
  */
 
 export const createBooleanState = (
   initialState: boolean,
+  options?: StateOptions<boolean>,
 ): readonly [
   state: InitializedObservable<boolean>,
   utils: Readonly<{
@@ -46,7 +50,7 @@ export const createBooleanState = (
   }>,
 ] => {
   const [state, setState, { updateState, resetState, getSnapshot }] =
-    createState(initialState);
+    createState(initialState, options);
 
   return [
     state,

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

@@ -0,0 +1,23 @@
+import { createBooleanState } from './create-boolean-state.mjs';
+
+describe(createBooleanState, () => {
+  test('with `equals`, setting what it already holds passes nothing on', () => {
+    const [state, { setTrue, setFalse }] = createBooleanState(false, {
+      equals: Object.is,
+    });
+
+    const mut_seen: boolean[] = [];
+
+    state.subscribe((value) => {
+      mut_seen.push(value);
+    });
+
+    setFalse();
+
+    setTrue();
+
+    setTrue();
+
+    assert.deepStrictEqual(mut_seen, [false, true]);
+  });
+});