react-rx 2.1.0 → 2.1.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.
- package/LICENSE +21 -0
- package/README.md +13 -0
- package/dist/cjs/__tests__/strictmode.test.d.ts +1 -0
- package/dist/cjs/__tests__/strictmode.test.js +111 -0
- package/dist/cjs/__tests__/useAsObservable.test.d.ts +1 -0
- package/dist/cjs/__tests__/useAsObservable.test.js +77 -0
- package/dist/cjs/__tests__/useObservable.test.d.ts +1 -0
- package/dist/cjs/__tests__/useObservable.test.js +116 -0
- package/dist/cjs/displayName.js +1 -0
- package/dist/cjs/reactiveComponent.js +2 -0
- package/dist/cjs/utils.js +5 -0
- package/dist/es2015/__tests__/strictmode.test.d.ts +1 -0
- package/dist/es2015/__tests__/strictmode.test.js +69 -0
- package/dist/es2015/__tests__/useAsObservable.test.d.ts +1 -0
- package/dist/es2015/__tests__/useAsObservable.test.js +72 -0
- package/dist/es2015/__tests__/useObservable.test.d.ts +1 -0
- package/dist/es2015/__tests__/useObservable.test.js +110 -0
- package/dist/es2015/displayName.js +1 -0
- package/dist/es2015/reactiveComponent.js +2 -0
- package/dist/es2015/utils.js +5 -0
- package/dist/esm/__tests__/strictmode.test.d.ts +1 -0
- package/dist/esm/__tests__/strictmode.test.js +109 -0
- package/dist/esm/__tests__/useAsObservable.test.d.ts +1 -0
- package/dist/esm/__tests__/useAsObservable.test.js +72 -0
- package/dist/esm/__tests__/useObservable.test.d.ts +1 -0
- package/dist/esm/__tests__/useObservable.test.js +114 -0
- package/dist/esm/displayName.js +1 -0
- package/dist/esm/reactiveComponent.js +2 -0
- package/dist/esm/utils.js +5 -0
- package/package.json +106 -24
- package/src/__tests__/strictmode.test.ts +79 -0
- package/src/__tests__/useAsObservable.test.tsx +94 -0
- package/src/__tests__/useObservable.test.tsx +145 -0
- package/src/displayName.ts +1 -0
- package/src/reactiveComponent.ts +3 -0
- package/src/useWithObservable.ts +1 -0
- package/src/utils.ts +5 -0
- package/.eslintrc.json +0 -13
- package/.idea/codeStyles/Project.xml +0 -113
- package/.idea/codeStyles/codeStyleConfig.xml +0 -5
- package/.idea/compiler.xml +0 -6
- package/.idea/encodings.xml +0 -4
- package/.idea/inspectionProfiles/Project_Default.xml +0 -7
- package/.idea/jsonSchemas.xml +0 -25
- package/.idea/markdown-navigator-enh.xml +0 -29
- package/.idea/markdown-navigator.xml +0 -55
- package/.idea/markdown.xml +0 -9
- package/.idea/misc.xml +0 -0
- package/.idea/modules.xml +0 -8
- package/.idea/react-rx.iml +0 -17
- package/.idea/vcs.xml +0 -6
- package/.prettierrc +0 -8
- package/jest.config.ts +0 -14
- package/tsconfig.json +0 -12
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2022 Sanity.io
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,3 +1,7 @@
|
|
|
1
|
+
[](https://github.com/sanity-io/react-rx/actions/workflows/ci.yml) [](https://www.npmjs.com/package/react-rx)
|
|
2
|
+
|
|
3
|
+
[](https://react-rx.dev/)
|
|
4
|
+
|
|
1
5
|
> Hooks and utilities for combining React with RxJS Observables
|
|
2
6
|
|
|
3
7
|
Features:
|
|
@@ -18,3 +22,12 @@ Although they share a lot of similarities, and reactiveComponent is built on top
|
|
|
18
22
|
- [Reactive components](https://react-rx.dev/guide#reactive-components)
|
|
19
23
|
- [Observable hooks](https://react-rx.dev/guide#observable-hooks)
|
|
20
24
|
- [Code examples](https://react-rx.dev/examples)
|
|
25
|
+
|
|
26
|
+
---
|
|
27
|
+
|
|
28
|
+
# Contributing and publishing new versions to npm
|
|
29
|
+
|
|
30
|
+
Run the ["CI & Release" workflow](https://github.com/sanity-io/react-rx/actions/workflows/ci.yml).
|
|
31
|
+
Make the default branch, `current`, should be preselected. Check "Release new version" and press "Run workflow'.
|
|
32
|
+
|
|
33
|
+
Semantic release will only release on configured branches, so it is safe to run release on any branch.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
3
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
4
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
5
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
6
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
7
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
8
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
9
|
+
});
|
|
10
|
+
};
|
|
11
|
+
var __generator = (this && this.__generator) || function (thisArg, body) {
|
|
12
|
+
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
|
|
13
|
+
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
|
|
14
|
+
function verb(n) { return function (v) { return step([n, v]); }; }
|
|
15
|
+
function step(op) {
|
|
16
|
+
if (f) throw new TypeError("Generator is already executing.");
|
|
17
|
+
while (_) try {
|
|
18
|
+
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
|
|
19
|
+
if (y = 0, t) op = [op[0] & 2, t.value];
|
|
20
|
+
switch (op[0]) {
|
|
21
|
+
case 0: case 1: t = op; break;
|
|
22
|
+
case 4: _.label++; return { value: op[1], done: false };
|
|
23
|
+
case 5: _.label++; y = op[1]; op = [0]; continue;
|
|
24
|
+
case 7: op = _.ops.pop(); _.trys.pop(); continue;
|
|
25
|
+
default:
|
|
26
|
+
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
|
|
27
|
+
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
|
|
28
|
+
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
|
|
29
|
+
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
|
|
30
|
+
if (t[2]) _.ops.pop();
|
|
31
|
+
_.trys.pop(); continue;
|
|
32
|
+
}
|
|
33
|
+
op = body.call(thisArg, _);
|
|
34
|
+
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
|
|
35
|
+
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
|
|
36
|
+
}
|
|
37
|
+
};
|
|
38
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
39
|
+
var rxjs_1 = require("rxjs");
|
|
40
|
+
var useObservable_1 = require("../useObservable");
|
|
41
|
+
var react_1 = require("react");
|
|
42
|
+
var react_2 = require("@testing-library/react");
|
|
43
|
+
var useAsObservable_1 = require("../useAsObservable");
|
|
44
|
+
var wait = function (ms) { return new Promise(function (resolve) { return setTimeout(resolve, ms); }); };
|
|
45
|
+
// NOTE: Jest runs NODE_ENV=test by default, which enables development flags for React
|
|
46
|
+
test('Strict mode should trigger double mount effects and re-renders', function () { return __awaiter(void 0, void 0, void 0, function () {
|
|
47
|
+
function ObservableComponent() {
|
|
48
|
+
(0, react_1.useEffect)(function () {
|
|
49
|
+
mountCount++;
|
|
50
|
+
}, []);
|
|
51
|
+
var observedValue = (0, useObservable_1.useObservable)(observable);
|
|
52
|
+
returnedValues.push(observedValue);
|
|
53
|
+
return (0, react_1.createElement)(react_1.Fragment, null, observedValue);
|
|
54
|
+
}
|
|
55
|
+
var subject, observable, returnedValues, mountCount, rerender;
|
|
56
|
+
return __generator(this, function (_a) {
|
|
57
|
+
switch (_a.label) {
|
|
58
|
+
case 0:
|
|
59
|
+
subject = new rxjs_1.BehaviorSubject(0);
|
|
60
|
+
observable = subject.asObservable();
|
|
61
|
+
returnedValues = [];
|
|
62
|
+
mountCount = 0;
|
|
63
|
+
rerender = (0, react_2.render)((0, react_1.createElement)(react_1.StrictMode, null, (0, react_1.createElement)(ObservableComponent))).rerender;
|
|
64
|
+
expect(mountCount).toEqual(2);
|
|
65
|
+
expect(returnedValues).toEqual([0, 0]);
|
|
66
|
+
return [4 /*yield*/, wait(10)];
|
|
67
|
+
case 1:
|
|
68
|
+
_a.sent();
|
|
69
|
+
(0, react_2.act)(function () { return subject.next(1); });
|
|
70
|
+
expect(returnedValues).toEqual([0, 0, 1, 1]);
|
|
71
|
+
(0, react_2.act)(function () { return subject.next(2); });
|
|
72
|
+
expect(returnedValues).toEqual([0, 0, 1, 1, 2, 2]);
|
|
73
|
+
expect(mountCount).toEqual(2);
|
|
74
|
+
return [2 /*return*/];
|
|
75
|
+
}
|
|
76
|
+
});
|
|
77
|
+
}); });
|
|
78
|
+
test('Strict mode should unsubscribe the source observable on unmount', function () {
|
|
79
|
+
var subscribed = false;
|
|
80
|
+
var observable = new rxjs_1.Observable(function () {
|
|
81
|
+
subscribed = true;
|
|
82
|
+
return function () {
|
|
83
|
+
subscribed = false;
|
|
84
|
+
};
|
|
85
|
+
});
|
|
86
|
+
function ObservableComponent() {
|
|
87
|
+
(0, useObservable_1.useObservable)(observable);
|
|
88
|
+
return (0, react_1.createElement)(react_1.Fragment, null);
|
|
89
|
+
}
|
|
90
|
+
var rerender = (0, react_2.render)((0, react_1.createElement)(react_1.StrictMode, null, (0, react_1.createElement)(ObservableComponent))).rerender;
|
|
91
|
+
expect(subscribed).toBe(true);
|
|
92
|
+
rerender((0, react_1.createElement)(react_1.StrictMode, null, (0, react_1.createElement)('div')));
|
|
93
|
+
expect(subscribed).toBe(false);
|
|
94
|
+
});
|
|
95
|
+
test('useAsObservable should work in strict mode', function () { return __awaiter(void 0, void 0, void 0, function () {
|
|
96
|
+
function ObservableComponent(props) {
|
|
97
|
+
var count$ = (0, useAsObservable_1.useAsObservable)(props.count);
|
|
98
|
+
var count = (0, useObservable_1.useObservable)(count$);
|
|
99
|
+
returnedValues.push(count);
|
|
100
|
+
return (0, react_1.createElement)(react_1.Fragment, null, 'ok');
|
|
101
|
+
}
|
|
102
|
+
var returnedValues, rerender;
|
|
103
|
+
return __generator(this, function (_a) {
|
|
104
|
+
returnedValues = [];
|
|
105
|
+
rerender = (0, react_2.render)((0, react_1.createElement)(react_1.StrictMode, null, (0, react_1.createElement)(ObservableComponent, { count: 0 }))).rerender;
|
|
106
|
+
expect(returnedValues).toEqual([0, 0]);
|
|
107
|
+
rerender((0, react_1.createElement)(react_1.StrictMode, null, (0, react_1.createElement)(ObservableComponent, { count: 1 })));
|
|
108
|
+
expect(returnedValues).toEqual([0, 0, 0, 0, 1, 1]);
|
|
109
|
+
return [2 /*return*/];
|
|
110
|
+
});
|
|
111
|
+
}); });
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
var useAsObservable_1 = require("../useAsObservable");
|
|
7
|
+
var react_1 = __importDefault(require("react"));
|
|
8
|
+
var react_2 = require("@testing-library/react");
|
|
9
|
+
test('the returned observable should receive a new value when component is rendered with a new value', function () {
|
|
10
|
+
var receivedValues = [];
|
|
11
|
+
var _a = (0, react_2.renderHook)(function (props) {
|
|
12
|
+
var observable = (0, useAsObservable_1.useAsObservable)(props.value);
|
|
13
|
+
react_1.default.useEffect(function () {
|
|
14
|
+
var subscription = observable.subscribe(function (v) {
|
|
15
|
+
receivedValues.push(v);
|
|
16
|
+
});
|
|
17
|
+
return function () {
|
|
18
|
+
subscription.unsubscribe();
|
|
19
|
+
};
|
|
20
|
+
}, []);
|
|
21
|
+
}, { initialProps: { value: 'initial' } }), unmount = _a.unmount, rerender = _a.rerender;
|
|
22
|
+
rerender({ value: 'rerender' });
|
|
23
|
+
rerender({ value: 'rerender again' });
|
|
24
|
+
expect(receivedValues).toEqual(['initial', 'rerender', 'rerender again']);
|
|
25
|
+
unmount();
|
|
26
|
+
});
|
|
27
|
+
test('the returned observable should *not* receive a new value when component is rendered with an unchanged value', function () {
|
|
28
|
+
var receivedValues = [];
|
|
29
|
+
var _a = (0, react_2.renderHook)(function (props) {
|
|
30
|
+
var observable = (0, useAsObservable_1.useAsObservable)(props.value);
|
|
31
|
+
react_1.default.useEffect(function () {
|
|
32
|
+
var subscription = observable.subscribe(function (v) {
|
|
33
|
+
receivedValues.push(v);
|
|
34
|
+
});
|
|
35
|
+
return function () {
|
|
36
|
+
subscription.unsubscribe();
|
|
37
|
+
};
|
|
38
|
+
}, []);
|
|
39
|
+
}, { initialProps: { value: 'some value' } }), unmount = _a.unmount, rerender = _a.rerender;
|
|
40
|
+
rerender({ value: 'some value' });
|
|
41
|
+
rerender({ value: 'some value' });
|
|
42
|
+
expect(receivedValues).toEqual(['some value']);
|
|
43
|
+
unmount();
|
|
44
|
+
});
|
|
45
|
+
test('the returned observable should have the same identity across multiple re-renders/hook calls', function () {
|
|
46
|
+
var returnValues = [];
|
|
47
|
+
var _a = (0, react_2.renderHook)(function () {
|
|
48
|
+
returnValues.push((0, useAsObservable_1.useAsObservable)('render'));
|
|
49
|
+
}), unmount = _a.unmount, rerender = _a.rerender;
|
|
50
|
+
rerender();
|
|
51
|
+
rerender();
|
|
52
|
+
var initial = returnValues[0], firstRerender = returnValues[1], secondRerender = returnValues[2];
|
|
53
|
+
expect(initial).toBe(firstRerender);
|
|
54
|
+
expect(firstRerender).toBe(secondRerender);
|
|
55
|
+
unmount();
|
|
56
|
+
});
|
|
57
|
+
test('the returned observable should complete on unmount', function () {
|
|
58
|
+
var didComplete = false;
|
|
59
|
+
var _a = (0, react_2.renderHook)(function () {
|
|
60
|
+
var observable = (0, useAsObservable_1.useAsObservable)('render');
|
|
61
|
+
react_1.default.useEffect(function () {
|
|
62
|
+
var subscription = observable.subscribe({
|
|
63
|
+
complete: function () {
|
|
64
|
+
didComplete = true;
|
|
65
|
+
},
|
|
66
|
+
});
|
|
67
|
+
return function () {
|
|
68
|
+
subscription.unsubscribe();
|
|
69
|
+
};
|
|
70
|
+
}, []);
|
|
71
|
+
}), unmount = _a.unmount, rerender = _a.rerender;
|
|
72
|
+
expect(didComplete).toBe(false);
|
|
73
|
+
rerender();
|
|
74
|
+
expect(didComplete).toBe(false);
|
|
75
|
+
unmount();
|
|
76
|
+
expect(didComplete).toBe(true);
|
|
77
|
+
});
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,116 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
var react_1 = require("@testing-library/react");
|
|
4
|
+
var useObservable_1 = require("../useObservable");
|
|
5
|
+
var rxjs_1 = require("rxjs");
|
|
6
|
+
var operators_1 = require("rxjs/operators");
|
|
7
|
+
var react_2 = require("react");
|
|
8
|
+
test('should subscribe immediately on component mount and unsubscribe on component unmount', function () {
|
|
9
|
+
var subscribed = false;
|
|
10
|
+
var observable = new rxjs_1.Observable(function () {
|
|
11
|
+
subscribed = true;
|
|
12
|
+
return function () {
|
|
13
|
+
subscribed = false;
|
|
14
|
+
};
|
|
15
|
+
});
|
|
16
|
+
expect(subscribed).toBe(false);
|
|
17
|
+
var unmount = (0, react_1.renderHook)(function () { return (0, useObservable_1.useObservable)(observable); }).unmount;
|
|
18
|
+
expect(subscribed).toBe(true);
|
|
19
|
+
unmount();
|
|
20
|
+
expect(subscribed).toBe(false);
|
|
21
|
+
});
|
|
22
|
+
test('should only subscribe once when given same observable on re-renders', function () {
|
|
23
|
+
var subscriptionCount = 0;
|
|
24
|
+
var observable = new rxjs_1.Observable(function () {
|
|
25
|
+
subscriptionCount++;
|
|
26
|
+
});
|
|
27
|
+
expect(subscriptionCount).toBe(0);
|
|
28
|
+
var _a = (0, react_1.renderHook)(function () { return (0, useObservable_1.useObservable)(observable); }), unmount = _a.unmount, rerender = _a.rerender;
|
|
29
|
+
expect(subscriptionCount).toBe(1);
|
|
30
|
+
rerender();
|
|
31
|
+
expect(subscriptionCount).toBe(1);
|
|
32
|
+
unmount();
|
|
33
|
+
(0, react_1.renderHook)(function () { return (0, useObservable_1.useObservable)(observable); });
|
|
34
|
+
expect(subscriptionCount).toBe(2);
|
|
35
|
+
});
|
|
36
|
+
test('should not return undefined during render if initial value is given', function () {
|
|
37
|
+
var observable = (0, rxjs_1.timer)(100).pipe((0, operators_1.mapTo)('emitted value'));
|
|
38
|
+
var returnedValues = [];
|
|
39
|
+
function ObservableComponent() {
|
|
40
|
+
var observedValue = (0, useObservable_1.useObservable)(observable, 'initial value');
|
|
41
|
+
returnedValues.push(observedValue);
|
|
42
|
+
return (0, react_2.createElement)(react_2.Fragment, null, observedValue);
|
|
43
|
+
}
|
|
44
|
+
(0, react_1.render)((0, react_2.createElement)(ObservableComponent));
|
|
45
|
+
expect(returnedValues).toEqual(expect.arrayContaining(['initial value']));
|
|
46
|
+
});
|
|
47
|
+
test('should not return undefined during render if observable is sync', function () {
|
|
48
|
+
var observable = (0, rxjs_1.of)('initial value');
|
|
49
|
+
var returnedValues = [];
|
|
50
|
+
function ObservableComponent() {
|
|
51
|
+
var observedValue = (0, useObservable_1.useObservable)(observable);
|
|
52
|
+
returnedValues.push(observedValue);
|
|
53
|
+
return (0, react_2.createElement)(react_2.Fragment, null, observedValue);
|
|
54
|
+
}
|
|
55
|
+
(0, react_1.render)((0, react_2.createElement)(ObservableComponent));
|
|
56
|
+
expect(returnedValues).toEqual(expect.arrayContaining(['initial value']));
|
|
57
|
+
});
|
|
58
|
+
test('should return undefined during first render if observable is async', function () {
|
|
59
|
+
var observable = (0, rxjs_1.scheduled)('async value', rxjs_1.asyncScheduler);
|
|
60
|
+
var returnedValues = [];
|
|
61
|
+
function ObservableComponent() {
|
|
62
|
+
var observedValue = (0, useObservable_1.useObservable)(observable);
|
|
63
|
+
returnedValues.push(observedValue);
|
|
64
|
+
return (0, react_2.createElement)(react_2.Fragment, null, observedValue);
|
|
65
|
+
}
|
|
66
|
+
(0, react_1.render)((0, react_2.createElement)(ObservableComponent));
|
|
67
|
+
expect(returnedValues).toEqual(expect.arrayContaining([undefined]));
|
|
68
|
+
});
|
|
69
|
+
test('should have sync values from an observable as initial value', function () {
|
|
70
|
+
var observable = (0, rxjs_1.of)('something sync');
|
|
71
|
+
var result = (0, react_1.renderHook)(function () { return (0, useObservable_1.useObservable)(observable); }).result;
|
|
72
|
+
expect(result.current).toBe('something sync');
|
|
73
|
+
});
|
|
74
|
+
test('should have undefined as initial value from delayed observables', function () {
|
|
75
|
+
var _a = (0, react_1.renderHook)(function () {
|
|
76
|
+
return (0, useObservable_1.useObservable)((0, rxjs_1.scheduled)('something async', rxjs_1.asyncScheduler));
|
|
77
|
+
}), result = _a.result, unmount = _a.unmount;
|
|
78
|
+
expect(result.current).toBeUndefined();
|
|
79
|
+
unmount();
|
|
80
|
+
});
|
|
81
|
+
test('should have passed initialValue as initial value from delayed observables', function () {
|
|
82
|
+
var _a = (0, react_1.renderHook)(function () {
|
|
83
|
+
return (0, useObservable_1.useObservable)((0, rxjs_1.scheduled)('something async', rxjs_1.asyncScheduler), 'initial');
|
|
84
|
+
}), result = _a.result, unmount = _a.unmount;
|
|
85
|
+
expect(result.current).toBe('initial');
|
|
86
|
+
unmount();
|
|
87
|
+
});
|
|
88
|
+
test('should update with values from observables', function () {
|
|
89
|
+
var values$ = new rxjs_1.Subject();
|
|
90
|
+
var _a = (0, react_1.renderHook)(function () { return (0, useObservable_1.useObservable)(values$); }), result = _a.result, unmount = _a.unmount;
|
|
91
|
+
expect(result.current).toBe(undefined);
|
|
92
|
+
(0, react_1.act)(function () { return values$.next('something'); });
|
|
93
|
+
expect(result.current).toBe('something');
|
|
94
|
+
(0, react_1.act)(function () { return values$.next('otherthing'); });
|
|
95
|
+
expect(result.current).toBe('otherthing');
|
|
96
|
+
unmount();
|
|
97
|
+
});
|
|
98
|
+
test('should re-subscribe when receiving a new observable', function () {
|
|
99
|
+
var first$ = new rxjs_1.Subject();
|
|
100
|
+
var second$ = new rxjs_1.Subject();
|
|
101
|
+
var current$ = first$;
|
|
102
|
+
var _a = (0, react_1.renderHook)(function () { return (0, useObservable_1.useObservable)(current$, '!!initial!!'); }), result = _a.result, rerender = _a.rerender, unmount = _a.unmount;
|
|
103
|
+
(0, react_1.act)(function () { return first$.next('first 1'); });
|
|
104
|
+
expect(result.current).toBe('first 1');
|
|
105
|
+
current$ = second$;
|
|
106
|
+
rerender();
|
|
107
|
+
// since observable #2 hasn't emitted a value yet, we should use the initial value
|
|
108
|
+
expect(result.current).toBe('!!initial!!');
|
|
109
|
+
// Now we should be subscribed to second$ and it's emission should be returned
|
|
110
|
+
(0, react_1.act)(function () { return second$.next('second 1'); });
|
|
111
|
+
expect(result.current).toBe('second 1');
|
|
112
|
+
// we should no longer be subscribed to the first and ignore any emissions
|
|
113
|
+
(0, react_1.act)(function () { return first$.next('first 2'); });
|
|
114
|
+
expect(result.current).toBe('second 1');
|
|
115
|
+
unmount();
|
|
116
|
+
});
|
package/dist/cjs/displayName.js
CHANGED
|
@@ -7,6 +7,7 @@ var getDisplayName = function (Component) {
|
|
|
7
7
|
}
|
|
8
8
|
return (Component && (Component.displayName || Component.name)) || 'Unknown';
|
|
9
9
|
};
|
|
10
|
+
// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/ban-types
|
|
10
11
|
var wrapDisplayName = function (BaseComponent, wrapperName) {
|
|
11
12
|
return "".concat(wrapperName, "(").concat(getDisplayName(BaseComponent), ")");
|
|
12
13
|
};
|
|
@@ -12,6 +12,7 @@ function fromComponent(component) {
|
|
|
12
12
|
wrappedComponent.displayName = (0, displayName_1.wrapDisplayName)(component, 'reactiveComponent');
|
|
13
13
|
return wrappedComponent;
|
|
14
14
|
}
|
|
15
|
+
// eslint-disable-next-line @typescript-eslint/ban-types
|
|
15
16
|
function fromObservable(input$) {
|
|
16
17
|
return function ReactiveComponent() {
|
|
17
18
|
return (0, react_1.createElement)(react_1.Fragment, null, (0, useObservable_1.useObservable)(input$));
|
|
@@ -23,6 +24,7 @@ function reactiveComponent(observableOrComponent) {
|
|
|
23
24
|
: fromObservable(observableOrComponent);
|
|
24
25
|
}
|
|
25
26
|
exports.reactiveComponent = reactiveComponent;
|
|
27
|
+
// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/ban-types
|
|
26
28
|
function forwardRef(component) {
|
|
27
29
|
var wrappedComponent = (0, react_1.forwardRef)(function (props, ref) {
|
|
28
30
|
return (0, react_1.createElement)(react_1.Fragment, null, (0, useObservable_1.useObservable)((0, react_1.useRef)(component((0, useAsObservable_1.useAsObservable)(props), ref)).current));
|
package/dist/cjs/utils.js
CHANGED
|
@@ -7,11 +7,14 @@ var operators_1 = require("rxjs/operators");
|
|
|
7
7
|
var react_1 = require("react");
|
|
8
8
|
var createState = function (initialState) { return (0, observable_callback_1.observableCallback)((0, operators_1.startWith)(initialState)); };
|
|
9
9
|
function observeState(initial) {
|
|
10
|
+
// eslint-disable-next-line react-hooks/rules-of-hooks
|
|
10
11
|
var _a = (0, react_1.useState)(initial), value = _a[0], update = _a[1];
|
|
12
|
+
// eslint-disable-next-line react-hooks/rules-of-hooks
|
|
11
13
|
return [(0, useAsObservable_1.useAsObservable)(value), update];
|
|
12
14
|
}
|
|
13
15
|
exports.observeState = observeState;
|
|
14
16
|
function observeCallback(operator) {
|
|
17
|
+
// eslint-disable-next-line react-hooks/rules-of-hooks
|
|
15
18
|
var ref = (0, react_1.useRef)();
|
|
16
19
|
if (!ref.current) {
|
|
17
20
|
ref.current = operator ? (0, observable_callback_1.observableCallback)(operator) : (0, observable_callback_1.observableCallback)();
|
|
@@ -20,10 +23,12 @@ function observeCallback(operator) {
|
|
|
20
23
|
}
|
|
21
24
|
exports.observeCallback = observeCallback;
|
|
22
25
|
function observeContext(context) {
|
|
26
|
+
// eslint-disable-next-line react-hooks/rules-of-hooks
|
|
23
27
|
return (0, useAsObservable_1.useAsObservable)((0, react_1.useContext)(context));
|
|
24
28
|
}
|
|
25
29
|
exports.observeContext = observeContext;
|
|
26
30
|
function observeElement() {
|
|
31
|
+
// eslint-disable-next-line react-hooks/rules-of-hooks
|
|
27
32
|
var ref = (0, react_1.useRef)();
|
|
28
33
|
if (!ref.current) {
|
|
29
34
|
ref.current = createState(null);
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
2
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
3
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
4
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
5
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
6
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
7
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
8
|
+
});
|
|
9
|
+
};
|
|
10
|
+
import { BehaviorSubject, Observable } from 'rxjs';
|
|
11
|
+
import { useObservable } from '../useObservable';
|
|
12
|
+
import { createElement, Fragment, StrictMode, useEffect } from 'react';
|
|
13
|
+
import { act, render } from '@testing-library/react';
|
|
14
|
+
import { useAsObservable } from '../useAsObservable';
|
|
15
|
+
const wait = (ms) => new Promise(resolve => setTimeout(resolve, ms));
|
|
16
|
+
// NOTE: Jest runs NODE_ENV=test by default, which enables development flags for React
|
|
17
|
+
test('Strict mode should trigger double mount effects and re-renders', () => __awaiter(void 0, void 0, void 0, function* () {
|
|
18
|
+
const subject = new BehaviorSubject(0);
|
|
19
|
+
const observable = subject.asObservable();
|
|
20
|
+
const returnedValues = [];
|
|
21
|
+
let mountCount = 0;
|
|
22
|
+
function ObservableComponent() {
|
|
23
|
+
useEffect(() => {
|
|
24
|
+
mountCount++;
|
|
25
|
+
}, []);
|
|
26
|
+
const observedValue = useObservable(observable);
|
|
27
|
+
returnedValues.push(observedValue);
|
|
28
|
+
return createElement(Fragment, null, observedValue);
|
|
29
|
+
}
|
|
30
|
+
const { rerender } = render(createElement(StrictMode, null, createElement(ObservableComponent)));
|
|
31
|
+
expect(mountCount).toEqual(2);
|
|
32
|
+
expect(returnedValues).toEqual([0, 0]);
|
|
33
|
+
yield wait(10);
|
|
34
|
+
act(() => subject.next(1));
|
|
35
|
+
expect(returnedValues).toEqual([0, 0, 1, 1]);
|
|
36
|
+
act(() => subject.next(2));
|
|
37
|
+
expect(returnedValues).toEqual([0, 0, 1, 1, 2, 2]);
|
|
38
|
+
expect(mountCount).toEqual(2);
|
|
39
|
+
}));
|
|
40
|
+
test('Strict mode should unsubscribe the source observable on unmount', () => {
|
|
41
|
+
let subscribed = false;
|
|
42
|
+
const observable = new Observable(() => {
|
|
43
|
+
subscribed = true;
|
|
44
|
+
return () => {
|
|
45
|
+
subscribed = false;
|
|
46
|
+
};
|
|
47
|
+
});
|
|
48
|
+
function ObservableComponent() {
|
|
49
|
+
useObservable(observable);
|
|
50
|
+
return createElement(Fragment, null);
|
|
51
|
+
}
|
|
52
|
+
const { rerender } = render(createElement(StrictMode, null, createElement(ObservableComponent)));
|
|
53
|
+
expect(subscribed).toBe(true);
|
|
54
|
+
rerender(createElement(StrictMode, null, createElement('div')));
|
|
55
|
+
expect(subscribed).toBe(false);
|
|
56
|
+
});
|
|
57
|
+
test('useAsObservable should work in strict mode', () => __awaiter(void 0, void 0, void 0, function* () {
|
|
58
|
+
const returnedValues = [];
|
|
59
|
+
function ObservableComponent(props) {
|
|
60
|
+
const count$ = useAsObservable(props.count);
|
|
61
|
+
const count = useObservable(count$);
|
|
62
|
+
returnedValues.push(count);
|
|
63
|
+
return createElement(Fragment, null, 'ok');
|
|
64
|
+
}
|
|
65
|
+
const { rerender } = render(createElement(StrictMode, null, createElement(ObservableComponent, { count: 0 })));
|
|
66
|
+
expect(returnedValues).toEqual([0, 0]);
|
|
67
|
+
rerender(createElement(StrictMode, null, createElement(ObservableComponent, { count: 1 })));
|
|
68
|
+
expect(returnedValues).toEqual([0, 0, 0, 0, 1, 1]);
|
|
69
|
+
}));
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
import { useAsObservable } from '../useAsObservable';
|
|
2
|
+
import React from 'react';
|
|
3
|
+
import { renderHook } from '@testing-library/react';
|
|
4
|
+
test('the returned observable should receive a new value when component is rendered with a new value', () => {
|
|
5
|
+
const receivedValues = [];
|
|
6
|
+
const { unmount, rerender } = renderHook((props) => {
|
|
7
|
+
const observable = useAsObservable(props.value);
|
|
8
|
+
React.useEffect(() => {
|
|
9
|
+
const subscription = observable.subscribe(v => {
|
|
10
|
+
receivedValues.push(v);
|
|
11
|
+
});
|
|
12
|
+
return () => {
|
|
13
|
+
subscription.unsubscribe();
|
|
14
|
+
};
|
|
15
|
+
}, []);
|
|
16
|
+
}, { initialProps: { value: 'initial' } });
|
|
17
|
+
rerender({ value: 'rerender' });
|
|
18
|
+
rerender({ value: 'rerender again' });
|
|
19
|
+
expect(receivedValues).toEqual(['initial', 'rerender', 'rerender again']);
|
|
20
|
+
unmount();
|
|
21
|
+
});
|
|
22
|
+
test('the returned observable should *not* receive a new value when component is rendered with an unchanged value', () => {
|
|
23
|
+
const receivedValues = [];
|
|
24
|
+
const { unmount, rerender } = renderHook((props) => {
|
|
25
|
+
const observable = useAsObservable(props.value);
|
|
26
|
+
React.useEffect(() => {
|
|
27
|
+
const subscription = observable.subscribe(v => {
|
|
28
|
+
receivedValues.push(v);
|
|
29
|
+
});
|
|
30
|
+
return () => {
|
|
31
|
+
subscription.unsubscribe();
|
|
32
|
+
};
|
|
33
|
+
}, []);
|
|
34
|
+
}, { initialProps: { value: 'some value' } });
|
|
35
|
+
rerender({ value: 'some value' });
|
|
36
|
+
rerender({ value: 'some value' });
|
|
37
|
+
expect(receivedValues).toEqual(['some value']);
|
|
38
|
+
unmount();
|
|
39
|
+
});
|
|
40
|
+
test('the returned observable should have the same identity across multiple re-renders/hook calls', () => {
|
|
41
|
+
const returnValues = [];
|
|
42
|
+
const { unmount, rerender } = renderHook(() => {
|
|
43
|
+
returnValues.push(useAsObservable('render'));
|
|
44
|
+
});
|
|
45
|
+
rerender();
|
|
46
|
+
rerender();
|
|
47
|
+
const [initial, firstRerender, secondRerender] = returnValues;
|
|
48
|
+
expect(initial).toBe(firstRerender);
|
|
49
|
+
expect(firstRerender).toBe(secondRerender);
|
|
50
|
+
unmount();
|
|
51
|
+
});
|
|
52
|
+
test('the returned observable should complete on unmount', () => {
|
|
53
|
+
let didComplete = false;
|
|
54
|
+
const { unmount, rerender } = renderHook(() => {
|
|
55
|
+
const observable = useAsObservable('render');
|
|
56
|
+
React.useEffect(() => {
|
|
57
|
+
const subscription = observable.subscribe({
|
|
58
|
+
complete: () => {
|
|
59
|
+
didComplete = true;
|
|
60
|
+
},
|
|
61
|
+
});
|
|
62
|
+
return () => {
|
|
63
|
+
subscription.unsubscribe();
|
|
64
|
+
};
|
|
65
|
+
}, []);
|
|
66
|
+
});
|
|
67
|
+
expect(didComplete).toBe(false);
|
|
68
|
+
rerender();
|
|
69
|
+
expect(didComplete).toBe(false);
|
|
70
|
+
unmount();
|
|
71
|
+
expect(didComplete).toBe(true);
|
|
72
|
+
});
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|