react-rx 3.0.0-0 → 3.0.0-1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (79) hide show
  1. package/dist/cjs/__tests__/strictmode.test.js +22 -62
  2. package/dist/cjs/__tests__/useObservable.test.js +32 -33
  3. package/dist/cjs/index.d.ts +2 -7
  4. package/dist/cjs/index.js +16 -26
  5. package/dist/cjs/useObservable.d.ts +0 -3
  6. package/dist/cjs/useObservable.js +58 -20
  7. package/dist/cjs/{useObservableCallback.js → useObservableEvent.js} +1 -2
  8. package/dist/es2015/__tests__/strictmode.test.js +6 -42
  9. package/dist/es2015/__tests__/useObservable.test.js +2 -3
  10. package/dist/es2015/index.d.ts +2 -7
  11. package/dist/es2015/index.js +2 -9
  12. package/dist/es2015/useObservable.d.ts +0 -3
  13. package/dist/es2015/useObservable.js +58 -19
  14. package/dist/es2015/{useObservableCallback.js → useObservableEvent.js} +1 -2
  15. package/dist/esm/__tests__/strictmode.test.js +8 -48
  16. package/dist/esm/__tests__/useObservable.test.js +2 -3
  17. package/dist/esm/index.d.ts +2 -7
  18. package/dist/esm/index.js +2 -9
  19. package/dist/esm/useObservable.d.ts +0 -3
  20. package/dist/esm/useObservable.js +58 -19
  21. package/dist/esm/{useObservableCallback.js → useObservableEvent.js} +1 -2
  22. package/package.json +35 -28
  23. package/src/__tests__/strictmode.test.ts +7 -52
  24. package/src/__tests__/useObservable.test.tsx +3 -3
  25. package/src/index.ts +2 -15
  26. package/src/useObservable.ts +75 -33
  27. package/src/{useObservableCallback.ts → useObservableEvent.ts} +1 -2
  28. package/dist/cjs/WithObservable.d.ts +0 -12
  29. package/dist/cjs/WithObservable.js +0 -16
  30. package/dist/cjs/__tests__/useAsObservable.test.d.ts +0 -1
  31. package/dist/cjs/__tests__/useAsObservable.test.js +0 -78
  32. package/dist/cjs/displayName.d.ts +0 -1
  33. package/dist/cjs/displayName.js +0 -14
  34. package/dist/cjs/reactiveComponent.d.ts +0 -8
  35. package/dist/cjs/reactiveComponent.js +0 -35
  36. package/dist/cjs/useAsObservable.d.ts +0 -10
  37. package/dist/cjs/useAsObservable.js +0 -47
  38. package/dist/cjs/useWithObservable.d.ts +0 -9
  39. package/dist/cjs/useWithObservable.js +0 -11
  40. package/dist/cjs/utils.d.ts +0 -7
  41. package/dist/cjs/utils.js +0 -38
  42. package/dist/es2015/WithObservable.d.ts +0 -12
  43. package/dist/es2015/WithObservable.js +0 -9
  44. package/dist/es2015/__tests__/useAsObservable.test.d.ts +0 -1
  45. package/dist/es2015/__tests__/useAsObservable.test.js +0 -73
  46. package/dist/es2015/displayName.d.ts +0 -1
  47. package/dist/es2015/displayName.js +0 -8
  48. package/dist/es2015/reactiveComponent.d.ts +0 -8
  49. package/dist/es2015/reactiveComponent.js +0 -30
  50. package/dist/es2015/useAsObservable.d.ts +0 -10
  51. package/dist/es2015/useAsObservable.js +0 -43
  52. package/dist/es2015/useWithObservable.d.ts +0 -9
  53. package/dist/es2015/useWithObservable.js +0 -7
  54. package/dist/es2015/utils.d.ts +0 -7
  55. package/dist/es2015/utils.js +0 -31
  56. package/dist/esm/WithObservable.d.ts +0 -12
  57. package/dist/esm/WithObservable.js +0 -13
  58. package/dist/esm/__tests__/useAsObservable.test.d.ts +0 -1
  59. package/dist/esm/__tests__/useAsObservable.test.js +0 -73
  60. package/dist/esm/displayName.d.ts +0 -1
  61. package/dist/esm/displayName.js +0 -10
  62. package/dist/esm/reactiveComponent.d.ts +0 -8
  63. package/dist/esm/reactiveComponent.js +0 -30
  64. package/dist/esm/useAsObservable.d.ts +0 -10
  65. package/dist/esm/useAsObservable.js +0 -43
  66. package/dist/esm/useWithObservable.d.ts +0 -9
  67. package/dist/esm/useWithObservable.js +0 -7
  68. package/dist/esm/utils.d.ts +0 -7
  69. package/dist/esm/utils.js +0 -31
  70. package/src/WithObservable.tsx +0 -29
  71. package/src/__tests__/useAsObservable.test.tsx +0 -95
  72. package/src/displayName.ts +0 -11
  73. package/src/reactiveComponent.ts +0 -63
  74. package/src/useAsObservable.ts +0 -66
  75. package/src/useWithObservable.ts +0 -24
  76. package/src/utils.ts +0 -48
  77. /package/dist/cjs/{useObservableCallback.d.ts → useObservableEvent.d.ts} +0 -0
  78. /package/dist/es2015/{useObservableCallback.d.ts → useObservableEvent.d.ts} +0 -0
  79. /package/dist/esm/{useObservableCallback.d.ts → useObservableEvent.d.ts} +0 -0
@@ -1,43 +0,0 @@
1
- import { BehaviorSubject } from 'rxjs';
2
- import { useCallback, useEffect, useRef } from 'react';
3
- import { distinctUntilChanged } from 'rxjs/operators';
4
- export function useAsObservable(value, operator) {
5
- const setup = useCallback(() => {
6
- const subject = new BehaviorSubject(value);
7
- const observable = subject.asObservable().pipe(distinctUntilChanged());
8
- return [operator ? observable.pipe(operator) : observable, subject];
9
- }, []);
10
- const ref = useRef();
11
- if (!ref.current) {
12
- ref.current = setup();
13
- }
14
- const [observable] = ref.current;
15
- useEffect(() => {
16
- if (!ref.current) {
17
- return;
18
- }
19
- const [, subject] = ref.current;
20
- subject.next(value);
21
- }, [value, ref]);
22
- const shouldRestoreSubscriptionRef = useRef(false);
23
- useEffect(() => {
24
- if (shouldRestoreSubscriptionRef.current) {
25
- if (!ref.current) {
26
- ref.current = setup();
27
- }
28
- shouldRestoreSubscriptionRef.current = false;
29
- }
30
- return () => {
31
- if (!ref.current) {
32
- return;
33
- }
34
- // React StrictMode will call effects as `setup + teardown + setup` thus we can't trust this callback as "react is about to unmount"
35
- // Tracking this ref lets us set the subscription back up on the next `setup` call if needed, and if it really did unmounted then all is well
36
- shouldRestoreSubscriptionRef.current = true;
37
- const [, subject] = ref.current;
38
- subject.complete();
39
- ref.current = undefined;
40
- };
41
- }, []);
42
- return observable;
43
- }
@@ -1,9 +0,0 @@
1
- import { Observable } from 'rxjs';
2
- /**
3
- * React hook to convert any props or state value into an observable
4
- * Returns an observable representing updates to any React value (props, state or any other calculated value)
5
- * Note: the returned observable is the same instance throughout the component lifecycle
6
- * @param value
7
- */
8
- export declare function useWithObservable<T>(value: T): T | undefined;
9
- export declare function useWithObservable<T, K>(value: T, operator: (input: Observable<T>) => Observable<K>): K | undefined;
@@ -1,7 +0,0 @@
1
- import { useObservable } from './useObservable';
2
- import { useAsObservable } from './useAsObservable';
3
- export function useWithObservable(value, operator) {
4
- return operator
5
- ? useObservable(useAsObservable(value, operator))
6
- : useObservable(useAsObservable(value));
7
- }
@@ -1,7 +0,0 @@
1
- import { Observable, OperatorFunction } from 'rxjs';
2
- import { Dispatch, SetStateAction, Context } from 'react';
3
- export declare function observeState<T>(initial: T | (() => T)): [Observable<T>, Dispatch<SetStateAction<T>>];
4
- export declare function observeCallback<T>(): [Observable<T>, (arg: T) => void];
5
- export declare function observeCallback<T, K>(operator: OperatorFunction<T, K>): [Observable<K>, (arg: T) => void];
6
- export declare function observeContext<T>(context: Context<T>): Observable<T>;
7
- export declare function observeElement<T>(): [Observable<T | null>, (el: T | null) => void];
@@ -1,31 +0,0 @@
1
- import { useAsObservable } from './useAsObservable';
2
- import { observableCallback } from 'observable-callback';
3
- import { startWith } from 'rxjs/operators';
4
- import { useContext, useRef, useState } from 'react';
5
- const createState = (initialState) => observableCallback(startWith(initialState));
6
- export function observeState(initial) {
7
- // eslint-disable-next-line react-hooks/rules-of-hooks
8
- const [value, update] = useState(initial);
9
- // eslint-disable-next-line react-hooks/rules-of-hooks
10
- return [useAsObservable(value), update];
11
- }
12
- export function observeCallback(operator) {
13
- // eslint-disable-next-line react-hooks/rules-of-hooks
14
- const ref = useRef();
15
- if (!ref.current) {
16
- ref.current = operator ? observableCallback(operator) : observableCallback();
17
- }
18
- return ref.current;
19
- }
20
- export function observeContext(context) {
21
- // eslint-disable-next-line react-hooks/rules-of-hooks
22
- return useAsObservable(useContext(context));
23
- }
24
- export function observeElement() {
25
- // eslint-disable-next-line react-hooks/rules-of-hooks
26
- const ref = useRef();
27
- if (!ref.current) {
28
- ref.current = createState(null);
29
- }
30
- return ref.current;
31
- }
@@ -1,12 +0,0 @@
1
- import { Observable } from 'rxjs';
2
- import { ComponentType, ReactNode } from 'react';
3
- interface Props<T> {
4
- observable: Observable<T>;
5
- children: (value: T) => ReactNode;
6
- }
7
- type ObservableComponent<T> = ComponentType<Props<T>>;
8
- /**
9
- * @deprecated Use the useObservable hook instead
10
- */
11
- export declare const WithObservable: ObservableComponent<unknown>;
12
- export {};
@@ -1,13 +0,0 @@
1
- import { distinctUntilChanged, map, switchMap } from 'rxjs/operators';
2
- import { reactiveComponent } from './reactiveComponent';
3
- function createWithObservable() {
4
- return reactiveComponent(function (props$) {
5
- return props$.pipe(distinctUntilChanged(function (props, prevProps) { return props.observable === prevProps.observable; }), switchMap(function (props) {
6
- return props.observable.pipe(map(function (observableValue) { return props.children(observableValue); }));
7
- }));
8
- });
9
- }
10
- /**
11
- * @deprecated Use the useObservable hook instead
12
- */
13
- export var WithObservable = createWithObservable();
@@ -1 +0,0 @@
1
- export {};
@@ -1,73 +0,0 @@
1
- import { useAsObservable } from '../useAsObservable';
2
- import React from 'react';
3
- import { renderHook } from '@testing-library/react';
4
- import { test, expect } from 'vitest';
5
- test('the returned observable should receive a new value when component is rendered with a new value', function () {
6
- var receivedValues = [];
7
- var _a = renderHook(function (props) {
8
- var observable = useAsObservable(props.value);
9
- React.useEffect(function () {
10
- var subscription = observable.subscribe(function (v) {
11
- receivedValues.push(v);
12
- });
13
- return function () {
14
- subscription.unsubscribe();
15
- };
16
- }, []);
17
- }, { initialProps: { value: 'initial' } }), unmount = _a.unmount, rerender = _a.rerender;
18
- rerender({ value: 'rerender' });
19
- rerender({ value: 'rerender again' });
20
- expect(receivedValues).toEqual(['initial', 'rerender', 'rerender again']);
21
- unmount();
22
- });
23
- test('the returned observable should *not* receive a new value when component is rendered with an unchanged value', function () {
24
- var receivedValues = [];
25
- var _a = renderHook(function (props) {
26
- var observable = useAsObservable(props.value);
27
- React.useEffect(function () {
28
- var subscription = observable.subscribe(function (v) {
29
- receivedValues.push(v);
30
- });
31
- return function () {
32
- subscription.unsubscribe();
33
- };
34
- }, []);
35
- }, { initialProps: { value: 'some value' } }), unmount = _a.unmount, rerender = _a.rerender;
36
- rerender({ value: 'some value' });
37
- rerender({ value: 'some value' });
38
- expect(receivedValues).toEqual(['some value']);
39
- unmount();
40
- });
41
- test('the returned observable should have the same identity across multiple re-renders/hook calls', function () {
42
- var returnValues = [];
43
- var _a = renderHook(function () {
44
- returnValues.push(useAsObservable('render'));
45
- }), unmount = _a.unmount, rerender = _a.rerender;
46
- rerender();
47
- rerender();
48
- var initial = returnValues[0], firstRerender = returnValues[1], secondRerender = returnValues[2];
49
- expect(initial).toBe(firstRerender);
50
- expect(firstRerender).toBe(secondRerender);
51
- unmount();
52
- });
53
- test('the returned observable should complete on unmount', function () {
54
- var didComplete = false;
55
- var _a = renderHook(function () {
56
- var observable = useAsObservable('render');
57
- React.useEffect(function () {
58
- var subscription = observable.subscribe({
59
- complete: function () {
60
- didComplete = true;
61
- },
62
- });
63
- return function () {
64
- subscription.unsubscribe();
65
- };
66
- }, []);
67
- }), unmount = _a.unmount, rerender = _a.rerender;
68
- expect(didComplete).toBe(false);
69
- rerender();
70
- expect(didComplete).toBe(false);
71
- unmount();
72
- expect(didComplete).toBe(true);
73
- });
@@ -1 +0,0 @@
1
- export declare const wrapDisplayName: (BaseComponent: Function, wrapperName: string) => string;
@@ -1,10 +0,0 @@
1
- var getDisplayName = function (Component) {
2
- if (typeof Component === 'string') {
3
- return Component;
4
- }
5
- return (Component && (Component.displayName || Component.name)) || 'Unknown';
6
- };
7
- // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/ban-types
8
- export var wrapDisplayName = function (BaseComponent, wrapperName) {
9
- return "".concat(wrapperName, "(").concat(getDisplayName(BaseComponent), ")");
10
- };
@@ -1,8 +0,0 @@
1
- import { Observable } from 'rxjs';
2
- import { FunctionComponent, ReactNode, Ref } from 'react';
3
- type Component<Props> = (input$: Observable<Props>) => Observable<ReactNode>;
4
- export declare function reactiveComponent<Props>(observable: Observable<Props>): FunctionComponent<Props>;
5
- export declare function reactiveComponent<Props>(component: Component<Props>): FunctionComponent<Props>;
6
- type ForwardRefComponent<RefType, Props> = (input$: Observable<Props>, ref: Ref<RefType>) => Observable<ReactNode>;
7
- export declare function forwardRef<RefType, Props = {}>(component: ForwardRefComponent<RefType, Props>): import("react").ForwardRefExoticComponent<import("react").PropsWithoutRef<Props> & import("react").RefAttributes<RefType>>;
8
- export {};
@@ -1,30 +0,0 @@
1
- import { wrapDisplayName } from './displayName';
2
- import { useAsObservable } from './useAsObservable';
3
- import { useObservable } from './useObservable';
4
- import { createElement, Fragment, useRef, forwardRef as reactForwardRef, } from 'react';
5
- function fromComponent(component) {
6
- var wrappedComponent = function (props) {
7
- return createElement(Fragment, null, useObservable(useRef(component(useAsObservable(props))).current));
8
- };
9
- wrappedComponent.displayName = wrapDisplayName(component, 'reactiveComponent');
10
- return wrappedComponent;
11
- }
12
- // eslint-disable-next-line @typescript-eslint/ban-types
13
- function fromObservable(input$) {
14
- return function ReactiveComponent() {
15
- return createElement(Fragment, null, useObservable(input$));
16
- };
17
- }
18
- export function reactiveComponent(observableOrComponent) {
19
- return typeof observableOrComponent === 'function'
20
- ? fromComponent(observableOrComponent)
21
- : fromObservable(observableOrComponent);
22
- }
23
- // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/ban-types
24
- export function forwardRef(component) {
25
- var wrappedComponent = reactForwardRef(function (props, ref) {
26
- return createElement(Fragment, null, useObservable(useRef(component(useAsObservable(props), ref)).current));
27
- });
28
- wrappedComponent.displayName = wrapDisplayName(component, 'reactiveComponent');
29
- return wrappedComponent;
30
- }
@@ -1,10 +0,0 @@
1
- import { Observable } from 'rxjs';
2
- /**
3
- * React hook to convert any props or state value into an observable
4
- * Returns an observable representing updates to any React value (props, state or any other calculated value)
5
- * Note: the returned observable is the same instance throughout the component lifecycle
6
- * @param value
7
- * @deprecated use an `of` operator and `useMemoObservable` instead for a faster, more robust and siimpler solution
8
- */
9
- export declare function useAsObservable<T>(value: T): Observable<T>;
10
- export declare function useAsObservable<T, K>(value: T, operator: (input: Observable<T>) => Observable<K>): Observable<K>;
@@ -1,43 +0,0 @@
1
- import { BehaviorSubject } from 'rxjs';
2
- import { useCallback, useEffect, useRef } from 'react';
3
- import { distinctUntilChanged } from 'rxjs/operators';
4
- export function useAsObservable(value, operator) {
5
- var setup = useCallback(function () {
6
- var subject = new BehaviorSubject(value);
7
- var observable = subject.asObservable().pipe(distinctUntilChanged());
8
- return [operator ? observable.pipe(operator) : observable, subject];
9
- }, []);
10
- var ref = useRef();
11
- if (!ref.current) {
12
- ref.current = setup();
13
- }
14
- var observable = ref.current[0];
15
- useEffect(function () {
16
- if (!ref.current) {
17
- return;
18
- }
19
- var _a = ref.current, subject = _a[1];
20
- subject.next(value);
21
- }, [value, ref]);
22
- var shouldRestoreSubscriptionRef = useRef(false);
23
- useEffect(function () {
24
- if (shouldRestoreSubscriptionRef.current) {
25
- if (!ref.current) {
26
- ref.current = setup();
27
- }
28
- shouldRestoreSubscriptionRef.current = false;
29
- }
30
- return function () {
31
- if (!ref.current) {
32
- return;
33
- }
34
- // React StrictMode will call effects as `setup + teardown + setup` thus we can't trust this callback as "react is about to unmount"
35
- // Tracking this ref lets us set the subscription back up on the next `setup` call if needed, and if it really did unmounted then all is well
36
- shouldRestoreSubscriptionRef.current = true;
37
- var _a = ref.current, subject = _a[1];
38
- subject.complete();
39
- ref.current = undefined;
40
- };
41
- }, []);
42
- return observable;
43
- }
@@ -1,9 +0,0 @@
1
- import { Observable } from 'rxjs';
2
- /**
3
- * React hook to convert any props or state value into an observable
4
- * Returns an observable representing updates to any React value (props, state or any other calculated value)
5
- * Note: the returned observable is the same instance throughout the component lifecycle
6
- * @param value
7
- */
8
- export declare function useWithObservable<T>(value: T): T | undefined;
9
- export declare function useWithObservable<T, K>(value: T, operator: (input: Observable<T>) => Observable<K>): K | undefined;
@@ -1,7 +0,0 @@
1
- import { useObservable } from './useObservable';
2
- import { useAsObservable } from './useAsObservable';
3
- export function useWithObservable(value, operator) {
4
- return operator
5
- ? useObservable(useAsObservable(value, operator))
6
- : useObservable(useAsObservable(value));
7
- }
@@ -1,7 +0,0 @@
1
- import { Observable, OperatorFunction } from 'rxjs';
2
- import { Dispatch, SetStateAction, Context } from 'react';
3
- export declare function observeState<T>(initial: T | (() => T)): [Observable<T>, Dispatch<SetStateAction<T>>];
4
- export declare function observeCallback<T>(): [Observable<T>, (arg: T) => void];
5
- export declare function observeCallback<T, K>(operator: OperatorFunction<T, K>): [Observable<K>, (arg: T) => void];
6
- export declare function observeContext<T>(context: Context<T>): Observable<T>;
7
- export declare function observeElement<T>(): [Observable<T | null>, (el: T | null) => void];
package/dist/esm/utils.js DELETED
@@ -1,31 +0,0 @@
1
- import { useAsObservable } from './useAsObservable';
2
- import { observableCallback } from 'observable-callback';
3
- import { startWith } from 'rxjs/operators';
4
- import { useContext, useRef, useState } from 'react';
5
- var createState = function (initialState) { return observableCallback(startWith(initialState)); };
6
- export function observeState(initial) {
7
- // eslint-disable-next-line react-hooks/rules-of-hooks
8
- var _a = useState(initial), value = _a[0], update = _a[1];
9
- // eslint-disable-next-line react-hooks/rules-of-hooks
10
- return [useAsObservable(value), update];
11
- }
12
- export function observeCallback(operator) {
13
- // eslint-disable-next-line react-hooks/rules-of-hooks
14
- var ref = useRef();
15
- if (!ref.current) {
16
- ref.current = operator ? observableCallback(operator) : observableCallback();
17
- }
18
- return ref.current;
19
- }
20
- export function observeContext(context) {
21
- // eslint-disable-next-line react-hooks/rules-of-hooks
22
- return useAsObservable(useContext(context));
23
- }
24
- export function observeElement() {
25
- // eslint-disable-next-line react-hooks/rules-of-hooks
26
- var ref = useRef();
27
- if (!ref.current) {
28
- ref.current = createState(null);
29
- }
30
- return ref.current;
31
- }
@@ -1,29 +0,0 @@
1
- import * as React from 'react'
2
- import {Observable} from 'rxjs'
3
- import {distinctUntilChanged, map, switchMap} from 'rxjs/operators'
4
- import {reactiveComponent} from './reactiveComponent'
5
- import {ComponentType, ReactNode} from 'react'
6
-
7
- interface Props<T> {
8
- observable: Observable<T>
9
- children: (value: T) => ReactNode
10
- }
11
-
12
- type ObservableComponent<T> = ComponentType<Props<T>>
13
-
14
- function createWithObservable<T>(): ObservableComponent<T> {
15
- return reactiveComponent((props$: Observable<Props<T>>) =>
16
- props$.pipe(
17
- distinctUntilChanged((props, prevProps) => props.observable === prevProps.observable),
18
- switchMap(
19
- (props): Observable<ReactNode> =>
20
- props.observable.pipe(map((observableValue: T) => props.children(observableValue))),
21
- ),
22
- ),
23
- )
24
- }
25
-
26
- /**
27
- * @deprecated Use the useObservable hook instead
28
- */
29
- export const WithObservable = createWithObservable()
@@ -1,95 +0,0 @@
1
- import {useAsObservable} from '../useAsObservable'
2
- import React from 'react'
3
- import {renderHook} from '@testing-library/react'
4
- import {Observable} from 'rxjs'
5
- import {test, expect} from 'vitest'
6
-
7
- test('the returned observable should receive a new value when component is rendered with a new value', () => {
8
- const receivedValues: string[] = []
9
- const {unmount, rerender} = renderHook(
10
- (props: {value: string}) => {
11
- const observable = useAsObservable(props.value)
12
-
13
- React.useEffect(() => {
14
- const subscription = observable.subscribe(v => {
15
- receivedValues.push(v)
16
- })
17
- return () => {
18
- subscription.unsubscribe()
19
- }
20
- }, [])
21
- },
22
- {initialProps: {value: 'initial'}},
23
- )
24
-
25
- rerender({value: 'rerender'})
26
- rerender({value: 'rerender again'})
27
-
28
- expect(receivedValues).toEqual(['initial', 'rerender', 'rerender again'])
29
-
30
- unmount()
31
- })
32
-
33
- test('the returned observable should *not* receive a new value when component is rendered with an unchanged value', () => {
34
- const receivedValues: string[] = []
35
- const {unmount, rerender} = renderHook(
36
- (props: {value: string}) => {
37
- const observable = useAsObservable(props.value)
38
-
39
- React.useEffect(() => {
40
- const subscription = observable.subscribe(v => {
41
- receivedValues.push(v)
42
- })
43
- return () => {
44
- subscription.unsubscribe()
45
- }
46
- }, [])
47
- },
48
- {initialProps: {value: 'some value'}},
49
- )
50
-
51
- rerender({value: 'some value'})
52
- rerender({value: 'some value'})
53
-
54
- expect(receivedValues).toEqual(['some value'])
55
-
56
- unmount()
57
- })
58
-
59
- test('the returned observable should have the same identity across multiple re-renders/hook calls', () => {
60
- const returnValues: Observable<unknown>[] = []
61
- const {unmount, rerender} = renderHook(() => {
62
- returnValues.push(useAsObservable('render'))
63
- })
64
-
65
- rerender()
66
- rerender()
67
-
68
- const [initial, firstRerender, secondRerender] = returnValues
69
- expect(initial).toBe(firstRerender)
70
- expect(firstRerender).toBe(secondRerender)
71
- unmount()
72
- })
73
-
74
- test('the returned observable should complete on unmount', () => {
75
- let didComplete = false
76
- const {unmount, rerender} = renderHook(() => {
77
- const observable = useAsObservable('render')
78
-
79
- React.useEffect(() => {
80
- const subscription = observable.subscribe({
81
- complete: () => {
82
- didComplete = true
83
- },
84
- })
85
- return () => {
86
- subscription.unsubscribe()
87
- }
88
- }, [])
89
- })
90
- expect(didComplete).toBe(false)
91
- rerender()
92
- expect(didComplete).toBe(false)
93
- unmount()
94
- expect(didComplete).toBe(true)
95
- })
@@ -1,11 +0,0 @@
1
- const getDisplayName = (Component: any) => {
2
- if (typeof Component === 'string') {
3
- return Component
4
- }
5
-
6
- return (Component && (Component.displayName || Component.name)) || 'Unknown'
7
- }
8
-
9
- // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/ban-types
10
- export const wrapDisplayName = (BaseComponent: Function, wrapperName: string) =>
11
- `${wrapperName}(${getDisplayName(BaseComponent)})`
@@ -1,63 +0,0 @@
1
- /* eslint-disable react-hooks/rules-of-hooks */
2
- import {Observable} from 'rxjs'
3
- import {wrapDisplayName} from './displayName'
4
- import {useAsObservable} from './useAsObservable'
5
- import {useObservable} from './useObservable'
6
- import {
7
- createElement,
8
- Fragment,
9
- FunctionComponent,
10
- ReactNode,
11
- Ref,
12
- useRef,
13
- forwardRef as reactForwardRef,
14
- } from 'react'
15
-
16
- type Component<Props> = (input$: Observable<Props>) => Observable<ReactNode>
17
-
18
- function fromComponent<Props>(component: Component<Props>): FunctionComponent<Props> {
19
- const wrappedComponent = (props: Props) => {
20
- return createElement(
21
- Fragment,
22
- null,
23
- useObservable<ReactNode>(useRef(component(useAsObservable(props))).current),
24
- )
25
- }
26
- wrappedComponent.displayName = wrapDisplayName(component, 'reactiveComponent')
27
- return wrappedComponent
28
- }
29
-
30
- // eslint-disable-next-line @typescript-eslint/ban-types
31
- function fromObservable<Props>(input$: Observable<ReactNode>): FunctionComponent<{}> {
32
- return function ReactiveComponent() {
33
- return createElement(Fragment, null, useObservable<ReactNode>(input$))
34
- }
35
- }
36
-
37
- export function reactiveComponent<Props>(observable: Observable<Props>): FunctionComponent<Props>
38
- export function reactiveComponent<Props>(component: Component<Props>): FunctionComponent<Props>
39
- export function reactiveComponent<Props>(
40
- observableOrComponent: Observable<ReactNode> | Component<Props>,
41
- ) {
42
- return typeof observableOrComponent === 'function'
43
- ? fromComponent(observableOrComponent)
44
- : fromObservable(observableOrComponent)
45
- }
46
-
47
- type ForwardRefComponent<RefType, Props> = (
48
- input$: Observable<Props>,
49
- ref: Ref<RefType>,
50
- ) => Observable<ReactNode>
51
-
52
- // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/ban-types
53
- export function forwardRef<RefType, Props = {}>(component: ForwardRefComponent<RefType, Props>) {
54
- const wrappedComponent = reactForwardRef((props: Props, ref: Ref<RefType>) => {
55
- return createElement(
56
- Fragment,
57
- null,
58
- useObservable<ReactNode>(useRef(component(useAsObservable(props), ref)).current),
59
- )
60
- })
61
- wrappedComponent.displayName = wrapDisplayName(component, 'reactiveComponent')
62
- return wrappedComponent
63
- }
@@ -1,66 +0,0 @@
1
- import {BehaviorSubject, Observable} from 'rxjs'
2
- import {useCallback, useEffect, useRef} from 'react'
3
- import {distinctUntilChanged} from 'rxjs/operators'
4
-
5
- /**
6
- * React hook to convert any props or state value into an observable
7
- * Returns an observable representing updates to any React value (props, state or any other calculated value)
8
- * Note: the returned observable is the same instance throughout the component lifecycle
9
- * @param value
10
- * @deprecated use an `of` operator and `useMemoObservable` instead for a faster, more robust and siimpler solution
11
- */
12
- export function useAsObservable<T>(value: T): Observable<T>
13
- export function useAsObservable<T, K>(
14
- value: T,
15
- operator: (input: Observable<T>) => Observable<K>,
16
- ): Observable<K>
17
- export function useAsObservable<T, K = T>(
18
- value: T,
19
- operator?: (input: Observable<T>) => Observable<K>,
20
- ): Observable<T | K> {
21
- const setup = useCallback((): [Observable<T | K>, BehaviorSubject<T>] => {
22
- const subject = new BehaviorSubject(value)
23
-
24
- const observable = subject.asObservable().pipe(distinctUntilChanged())
25
- return [operator ? observable.pipe(operator) : observable, subject]
26
- }, [])
27
-
28
- const ref = useRef<[Observable<T | K>, BehaviorSubject<T>]>()
29
-
30
- if (!ref.current) {
31
- ref.current = setup()
32
- }
33
-
34
- const [observable] = ref.current
35
-
36
- useEffect(() => {
37
- if (!ref.current) {
38
- return
39
- }
40
- const [, subject] = ref.current
41
- subject.next(value)
42
- }, [value, ref])
43
-
44
- const shouldRestoreSubscriptionRef = useRef(false)
45
- useEffect(() => {
46
- if (shouldRestoreSubscriptionRef.current) {
47
- if (!ref.current) {
48
- ref.current = setup()
49
- }
50
- shouldRestoreSubscriptionRef.current = false
51
- }
52
-
53
- return () => {
54
- if (!ref.current) {
55
- return
56
- }
57
- // React StrictMode will call effects as `setup + teardown + setup` thus we can't trust this callback as "react is about to unmount"
58
- // Tracking this ref lets us set the subscription back up on the next `setup` call if needed, and if it really did unmounted then all is well
59
- shouldRestoreSubscriptionRef.current = true
60
- const [, subject] = ref.current
61
- subject.complete()
62
- ref.current = undefined
63
- }
64
- }, [])
65
- return observable
66
- }