synstate-react-hooks-compat 6.1.1 → 6.2.0

package/README.md

@@ -1,6 +1,6 @@
 # SynState React hooks (compat)
 
-synstate-react-hooks-compat re-exports all exports from synstate except for `createState`, `createReducer`, and `createBooleanState`, and exports modified versions of those creation functions.
+synstate-react-hooks-compat re-exports every function and type synstate exports except for `createState`, `createReducer`, and `createBooleanState`, and exports modified versions of those creation functions.
 
 The first element of the array returned by the `createState<T>` function provided by synstate-react-hooks-compat is changed from `InitializedObservable<T>` to a React hook `() => T`, and the `InitializedObservable<T>` has been moved to the `state` property in the object at index 2.
 

package/dist/synstate.d.mts

@@ -1,2 +1,3 @@
 export { attachIndex, audit, collectToArray, combine, combineLatest, counter, createAsyncChildObservable, createEventEmitter, createInitializedSyncChildObservable, createRootObservable, createScope, createSyncChildObservable, createValueEmitter, debounce, derive, distinctUntilChanged, empty, filter, flatMap, fromAbortablePromise, fromPromise, fromSubscribable, getCurrentScope, getKey, isChildObservable, isManagerObservable, isObservable, isRootObservable, just, keepEqualParts, map, mapOptional, mapResultErr, mapResultOk, mapTo, merge, mergeMap, onScopeDispose, pairwise, pluck, scan, skip, skipIfNoChange, skipUntil, skipWhile, source, switchMap, take, takeUntil, takeWhile, throttle, timer, untracked, unwrapOptional, unwrapResultErr, unwrapResultOk, withBuffered, withBufferedFrom, withCurrentValueFrom, withIndex, withInitialValue, withLatestFrom, zip, } from 'synstate';
+export type { AsyncChildObservable, AsyncChildObservableHooks, AsyncChildObservableTools, AuditOperatorObservable, ChildObservable, ChildObservableConfig, ChildObservableKind, CombineObservable, CombineObservableRefined, CounterObservable, DebounceOperatorObservable, DeriveObservable, DeriveObservableRefined, DropInitialValueOperator, FilterOperatorObservable, FromPromiseObservable, FromSubscribableObservable, InitializedAsyncChildObservable, InitializedChildObservableConfig, InitializedObservable, InitializedRootObservable, InitializedSourceObservable, InitializedSyncChildObservable, KeepEqualPartsOperatorObservable, KeepInitialValueOperator, ManagerObservable, ManagerObservableKind, MapOperatorObservable, MergeMapOperatorObservable, MergeObservable, MergeObservableRefined, NonEmptyUnknownList, Observable, ObservableBase, ObservableKind, ObservableValue, Operator, PairwiseOperatorObservable, RootObservable, RootObservableConfig, RootObservableTools, ScanOperatorObservable, Scope, SkipIfNoChangeOperatorObservable, SkipUntilOperatorObservable, SkipWhileOperatorObservable, SourceObservable, StateOptions, Subscribable, Subscriber, Subscription, SwitchMapOperatorObservable, SyncChildObservable, SyncChildObservableHooks, SyncChildObservableTools, TakeOperatorObservable, TakeUntilOperatorObservable, TakeWhileOperatorObservable, ThrottleOperatorObservable, TimerId, TimerObservable, TupleToQueueTuple, Unwrap, UpdateToken, WithBufferedFromOperatorObservable, WithCurrentValueFromOperatorObservable, WithInitialValueOperator, WithInitialValueOperatorObservable, Wrap, WrapInitialized, ZipObservable, ZipObservableRefined, } from 'synstate';
 //# sourceMappingURL=synstate.d.mts.map

package/dist/synstate.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"synstate.d.mts","sourceRoot":"","sources":["../src/synstate.mts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,KAAK,EACL,cAAc,EACd,OAAO,EACP,aAAa,EACb,OAAO,EACP,0BAA0B,EAC1B,kBAAkB,EAClB,oCAAoC,EACpC,oBAAoB,EACpB,WAAW,EACX,yBAAyB,EACzB,kBAAkB,EAClB,QAAQ,EACR,MAAM,EACN,oBAAoB,EACpB,KAAK,EACL,MAAM,EACN,OAAO,EACP,oBAAoB,EACpB,WAAW,EACX,gBAAgB,EAChB,eAAe,EACf,MAAM,EACN,iBAAiB,EACjB,mBAAmB,EACnB,YAAY,EACZ,gBAAgB,EAChB,IAAI,EACJ,cAAc,EACd,GAAG,EACH,WAAW,EACX,YAAY,EACZ,WAAW,EACX,KAAK,EACL,KAAK,EACL,QAAQ,EACR,cAAc,EACd,QAAQ,EACR,KAAK,EACL,IAAI,EACJ,IAAI,EACJ,cAAc,EACd,SAAS,EACT,SAAS,EACT,MAAM,EACN,SAAS,EACT,IAAI,EACJ,SAAS,EACT,SAAS,EACT,QAAQ,EACR,KAAK,EACL,SAAS,EACT,cAAc,EACd,eAAe,EACf,cAAc,EACd,YAAY,EACZ,gBAAgB,EAChB,oBAAoB,EACpB,SAAS,EACT,gBAAgB,EAChB,cAAc,EACd,GAAG,GACJ,MAAM,UAAU,CAAC"}
+{"version":3,"file":"synstate.d.mts","sourceRoot":"","sources":["../src/synstate.mts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,KAAK,EACL,cAAc,EACd,OAAO,EACP,aAAa,EACb,OAAO,EACP,0BAA0B,EAC1B,kBAAkB,EAClB,oCAAoC,EACpC,oBAAoB,EACpB,WAAW,EACX,yBAAyB,EACzB,kBAAkB,EAClB,QAAQ,EACR,MAAM,EACN,oBAAoB,EACpB,KAAK,EACL,MAAM,EACN,OAAO,EACP,oBAAoB,EACpB,WAAW,EACX,gBAAgB,EAChB,eAAe,EACf,MAAM,EACN,iBAAiB,EACjB,mBAAmB,EACnB,YAAY,EACZ,gBAAgB,EAChB,IAAI,EACJ,cAAc,EACd,GAAG,EACH,WAAW,EACX,YAAY,EACZ,WAAW,EACX,KAAK,EACL,KAAK,EACL,QAAQ,EACR,cAAc,EACd,QAAQ,EACR,KAAK,EACL,IAAI,EACJ,IAAI,EACJ,cAAc,EACd,SAAS,EACT,SAAS,EACT,MAAM,EACN,SAAS,EACT,IAAI,EACJ,SAAS,EACT,SAAS,EACT,QAAQ,EACR,KAAK,EACL,SAAS,EACT,cAAc,EACd,eAAe,EACf,cAAc,EACd,YAAY,EACZ,gBAAgB,EAChB,oBAAoB,EACpB,SAAS,EACT,gBAAgB,EAChB,cAAc,EACd,GAAG,GACJ,MAAM,UAAU,CAAC;AAElB,YAAY,EACV,oBAAoB,EACpB,yBAAyB,EACzB,yBAAyB,EACzB,uBAAuB,EACvB,eAAe,EACf,qBAAqB,EACrB,mBAAmB,EACnB,iBAAiB,EACjB,wBAAwB,EACxB,iBAAiB,EACjB,0BAA0B,EAC1B,gBAAgB,EAChB,uBAAuB,EACvB,wBAAwB,EACxB,wBAAwB,EACxB,qBAAqB,EACrB,0BAA0B,EAC1B,+BAA+B,EAC/B,gCAAgC,EAChC,qBAAqB,EACrB,yBAAyB,EACzB,2BAA2B,EAC3B,8BAA8B,EAC9B,gCAAgC,EAChC,wBAAwB,EACxB,iBAAiB,EACjB,qBAAqB,EACrB,qBAAqB,EACrB,0BAA0B,EAC1B,eAAe,EACf,sBAAsB,EACtB,mBAAmB,EACnB,UAAU,EACV,cAAc,EACd,cAAc,EACd,eAAe,EACf,QAAQ,EACR,0BAA0B,EAC1B,cAAc,EACd,oBAAoB,EACpB,mBAAmB,EACnB,sBAAsB,EACtB,KAAK,EACL,gCAAgC,EAChC,2BAA2B,EAC3B,2BAA2B,EAC3B,gBAAgB,EAChB,YAAY,EACZ,YAAY,EACZ,UAAU,EACV,YAAY,EACZ,2BAA2B,EAC3B,mBAAmB,EACnB,wBAAwB,EACxB,wBAAwB,EACxB,sBAAsB,EACtB,2BAA2B,EAC3B,2BAA2B,EAC3B,0BAA0B,EAC1B,OAAO,EACP,eAAe,EACf,iBAAiB,EACjB,MAAM,EACN,WAAW,EACX,kCAAkC,EAClC,sCAAsC,EACtC,wBAAwB,EACxB,kCAAkC,EAClC,IAAI,EACJ,eAAe,EACf,aAAa,EACb,oBAAoB,GACrB,MAAM,UAAU,CAAC"}

package/dist/use-observable-effect.d.mts

@@ -1,3 +1,17 @@
 import type { Observable } from 'synstate';
+/**
+ * Subscribes `subscriptionFn` to `observable$` while the component is
+ * mounted, and unsubscribes when it unmounts.
+ *
+ * Each value is passed to the `subscriptionFn` of the latest render, so it
+ * sees the current props and state; a new function on every render does not
+ * re-subscribe. Passing a different Observable moves the subscription to it,
+ * so pass one that keeps its identity across renders (made outside the
+ * component, or memoized): one built during render is subscribed again, and
+ * an initialized one calls `subscriptionFn` again, on every render.
+ *
+ * @param observable$ The Observable to subscribe to.
+ * @param subscriptionFn Called with each value `observable$` emits.
+ */
 export declare const useObservableEffect: <A>(observable$: Observable<A>, subscriptionFn: (v: A) => void) => void;
 //# sourceMappingURL=use-observable-effect.d.mts.map

package/dist/use-observable-effect.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"use-observable-effect.d.mts","sourceRoot":"","sources":["../src/use-observable-effect.mts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAE3C,eAAO,MAAM,mBAAmB,GAAI,CAAC,eACtB,UAAU,CAAC,CAAC,CAAC,kBACV,CAAC,CAAC,EAAE,CAAC,KAAK,IAAI,KAC7B,IAQF,CAAC"}
+{"version":3,"file":"use-observable-effect.d.mts","sourceRoot":"","sources":["../src/use-observable-effect.mts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAE3C;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,mBAAmB,GAAI,CAAC,eACtB,UAAU,CAAC,CAAC,CAAC,kBACV,CAAC,CAAC,EAAE,CAAC,KAAK,IAAI,KAC7B,IAmBF,CAAC"}

package/dist/use-observable-effect.mjs

@@ -1,10 +1,41 @@
 import * as React from 'react';
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 export const useObservableEffect = (observable$, subscriptionFn) => {
+    const mut_subscriptionFnRef = React.useRef(subscriptionFn);
+
+
+
+    useBeforeEffects(() => {
+        mut_subscriptionFnRef.current = subscriptionFn;
+    });
     React.useEffect(() => {
-        const s = observable$.subscribe(subscriptionFn);
+        const s = observable$.subscribe((v) => {
+            mut_subscriptionFnRef.current(v);
+        });
         return () => {
             s.unsubscribe();
         };
-    }, []);
+    }, [observable$]);
 };
+
+
+
+
+const useBeforeEffects = 
+
+React.useInsertionEffect ??
+    (typeof window === 'undefined' ? React.useEffect : React.useLayoutEffect);
 //# sourceMappingURL=use-observable-effect.mjs.map

package/dist/use-observable-effect.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"use-observable-effect.mjs","sourceRoot":"","sources":["../src/use-observable-effect.mts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAG/B,MAAM,CAAC,MAAM,mBAAmB,GAAG,CACjC,WAA0B,EAC1B,cAA8B,EACxB,EAAE;IACR,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,MAAM,CAAC,GAAG,WAAW,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;QAEhD,OAAO,GAAG,EAAE;YACV,CAAC,CAAC,WAAW,EAAE,CAAC;QAClB,CAAC,CAAC;IACJ,CAAC,EAAE,EAAE,CAAC,CAAC;AACT,CAAC,CAAC"}
+{"version":3,"file":"use-observable-effect.mjs","sourceRoot":"","sources":["../src/use-observable-effect.mts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAG/B;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CACjC,WAA0B,EAC1B,cAA8B,EACxB,EAAE;IACR,MAAM,qBAAqB,GAAG,KAAK,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;IAE3D,2EAA2E;IAC3E,qEAAqE;IACrE,oBAAoB;IACpB,gBAAgB,CAAC,GAAG,EAAE;QACpB,qBAAqB,CAAC,OAAO,GAAG,cAAc,CAAC;IACjD,CAAC,CAAC,CAAC;IAEH,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,MAAM,CAAC,GAAG,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;YACpC,qBAAqB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;QAEH,OAAO,GAAG,EAAE;YACV,CAAC,CAAC,WAAW,EAAE,CAAC;QAClB,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;AACpB,CAAC,CAAC;AAEF,8EAA8E;AAC9E,wEAAwE;AACxE,2EAA2E;AAC3E,6CAA6C;AAC7C,MAAM,gBAAgB;AACpB,4HAA4H;AAC5H,KAAK,CAAC,kBAAkB;IACxB,CAAC,OAAO,MAAM,KAAK,WAAW,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "synstate-react-hooks-compat",
-  "version": "6.1.1",
+  "version": "6.2.0",
   "description": "SynState React hooks for React 16.8–17 (without useSyncExternalStore)",
   "repository": {
     "type": "git",
@@ -38,10 +38,10 @@
     "@types/react": "19.3.0",
     "@types/react-dom": "19.3.0",
     "@vitest/browser-playwright": "5.0.5",
-    "eslint-config-typed": "7.1.0",
-    "eslint-plugin-ts-data-forge": "0.10.5",
-    "eslint-plugin-ts-fortress": "1.3.10",
-    "eslint-plugin-ts-type-forge": "0.8.15",
+    "eslint-config-typed": "7.2.1",
+    "eslint-plugin-ts-data-forge": "0.10.6",
+    "eslint-plugin-ts-fortress": "1.3.11",
+    "eslint-plugin-ts-type-forge": "0.8.16",
     "playwright": "1.64.1",
     "prettier": "3.9.10",
     "prettier-plugin-organize-imports": "4.3.0",

package/src/synstate.mts

@@ -63,3 +63,78 @@ export {
   withLatestFrom,
   zip,
 } from 'synstate';
+
+export type {
+  AsyncChildObservable,
+  AsyncChildObservableHooks,
+  AsyncChildObservableTools,
+  AuditOperatorObservable,
+  ChildObservable,
+  ChildObservableConfig,
+  ChildObservableKind,
+  CombineObservable,
+  CombineObservableRefined,
+  CounterObservable,
+  DebounceOperatorObservable,
+  DeriveObservable,
+  DeriveObservableRefined,
+  DropInitialValueOperator,
+  FilterOperatorObservable,
+  FromPromiseObservable,
+  FromSubscribableObservable,
+  InitializedAsyncChildObservable,
+  InitializedChildObservableConfig,
+  InitializedObservable,
+  InitializedRootObservable,
+  InitializedSourceObservable,
+  InitializedSyncChildObservable,
+  KeepEqualPartsOperatorObservable,
+  KeepInitialValueOperator,
+  ManagerObservable,
+  ManagerObservableKind,
+  MapOperatorObservable,
+  MergeMapOperatorObservable,
+  MergeObservable,
+  MergeObservableRefined,
+  NonEmptyUnknownList,
+  Observable,
+  ObservableBase,
+  ObservableKind,
+  ObservableValue,
+  Operator,
+  PairwiseOperatorObservable,
+  RootObservable,
+  RootObservableConfig,
+  RootObservableTools,
+  ScanOperatorObservable,
+  Scope,
+  SkipIfNoChangeOperatorObservable,
+  SkipUntilOperatorObservable,
+  SkipWhileOperatorObservable,
+  SourceObservable,
+  StateOptions,
+  Subscribable,
+  Subscriber,
+  Subscription,
+  SwitchMapOperatorObservable,
+  SyncChildObservable,
+  SyncChildObservableHooks,
+  SyncChildObservableTools,
+  TakeOperatorObservable,
+  TakeUntilOperatorObservable,
+  TakeWhileOperatorObservable,
+  ThrottleOperatorObservable,
+  TimerId,
+  TimerObservable,
+  TupleToQueueTuple,
+  Unwrap,
+  UpdateToken,
+  WithBufferedFromOperatorObservable,
+  WithCurrentValueFromOperatorObservable,
+  WithInitialValueOperator,
+  WithInitialValueOperatorObservable,
+  Wrap,
+  WrapInitialized,
+  ZipObservable,
+  ZipObservableRefined,
+} from 'synstate';

package/src/use-observable-effect.mts

@@ -1,15 +1,49 @@
 import * as React from 'react';
 import type { Observable } from 'synstate';
 
+/**
+ * Subscribes `subscriptionFn` to `observable$` while the component is
+ * mounted, and unsubscribes when it unmounts.
+ *
+ * Each value is passed to the `subscriptionFn` of the latest render, so it
+ * sees the current props and state; a new function on every render does not
+ * re-subscribe. Passing a different Observable moves the subscription to it,
+ * so pass one that keeps its identity across renders (made outside the
+ * component, or memoized): one built during render is subscribed again, and
+ * an initialized one calls `subscriptionFn` again, on every render.
+ *
+ * @param observable$ The Observable to subscribe to.
+ * @param subscriptionFn Called with each value `observable$` emits.
+ */
 export const useObservableEffect = <A,>(
   observable$: Observable<A>,
   subscriptionFn: (v: A) => void,
 ): void => {
+  const mut_subscriptionFnRef = React.useRef(subscriptionFn);
+
+  // On React 18 and later, runs before the layout and passive effects of the
+  // commit, so a value one of them emits already reaches this render's
+  // `subscriptionFn`.
+  useBeforeEffects(() => {
+    mut_subscriptionFnRef.current = subscriptionFn;
+  });
+
   React.useEffect(() => {
-    const s = observable$.subscribe(subscriptionFn);
+    const s = observable$.subscribe((v) => {
+      mut_subscriptionFnRef.current(v);
+    });
 
     return () => {
       s.unsubscribe();
     };
-  }, []);
+  }, [observable$]);
 };
+
+// `useInsertionEffect` is React 18's (`'useInsertionEffect' in React` narrows
+// to `never`, as the types have it). Before it, `useLayoutEffect` comes
+// closest, running before the passive effects only; it warns when rendered
+// on the server, where nothing emits anyway.
+const useBeforeEffects: typeof React.useLayoutEffect =
+  // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- React 16 and 17 have none, whatever the types say
+  React.useInsertionEffect ??
+  (typeof window === 'undefined' ? React.useEffect : React.useLayoutEffect);